From a7f30018f179cdd2ee56cbd8f6162bc71acf7ffe Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 22 Jun 2026 15:32:02 -0500 Subject: [PATCH 01/10] build(spectaql): split GraphQL reference into per-page letter-range chunks Replace byte-sized chunkByH3 splitting with fixed alphabetical type ranges (a-b through t-z). Write separate reference pages (queries, mutations, types-*) with one Fragment each instead of stacking all chunks on index.md. Point the default 2.4.9 output at src/pages/reference/graphql/latest/. --- scripts/generate-spectaql-md.js | 247 ++++++++++++++++++++++---------- spectaql/README.md | 24 ++-- 2 files changed, 190 insertions(+), 81 deletions(-) diff --git a/scripts/generate-spectaql-md.js b/scripts/generate-spectaql-md.js index c137785c0..a0e1e1e2f 100644 --- a/scripts/generate-spectaql-md.js +++ b/scripts/generate-spectaql-md.js @@ -1,7 +1,7 @@ #!/usr/bin/env node // Runs SpectaQL for each GraphQL schema version, splits the monolithic output -// into per-section chunk files, and syncs the Fragment includes in the -// corresponding index.md. +// into per-section chunk files, and syncs reference pages that embed each chunk +// via a single Fragment include. // // Usage: // npm run generate:graphql-api-docs # all versions @@ -15,9 +15,18 @@ const yaml = require('js-yaml'); const ROOT = path.join(__dirname, '..'); -// Maximum bytes per types chunk file. Individual type entries may push a chunk -// slightly over this limit; the boundary is always at an H3 heading. -const MAX_TYPES_CHUNK_BYTES = 200 * 1024; +// Types are split into fixed alphabetical ranges so each range maps to its own +// reference page instead of byte-sized chunks that still load on one page. +const TYPE_LETTER_RANGES = [ + { suffix: 'a-b', letters: 'AB', navTitle: 'Types A–B', heading: 'Types A–B' }, + { suffix: 'c-e', letters: 'CDE', navTitle: 'Types C–E', heading: 'Types C–E' }, + { suffix: 'f-i', letters: 'FGHIJ', navTitle: 'Types F–I', heading: 'Types F–I' }, + { suffix: 'k-p', letters: 'KLMNOP', navTitle: 'Types K–P', heading: 'Types K–P' }, + { suffix: 'q-s', letters: 'QRS', navTitle: 'Types Q–S', heading: 'Types Q–S' }, + { suffix: 't-z', letters: 'TUVWXYZ', navTitle: 'Types T–Z', heading: 'Types T–Z' }, +]; + +const TYPES_HEADER = '## Types\n\n'; // Reads spectaql.targetDir and spectaql.targetFile from a config YAML and // returns the resolved absolute path of the output file. @@ -63,62 +72,133 @@ function parseSections(content) { return sections; } -// Split a block of content at H3 boundaries into chunks whose UTF-8 size does -// not exceed maxBytes (unless a single entry is already larger). -function chunkByH3(content, maxBytes) { - // Split at the start of every H3 heading using a lookahead so the delimiter - // stays attached to the following chunk. - const parts = content.split(/(?=^### )/m); - - if (parts.length <= 1) return [content]; +function letterRangeFor(typeName) { + const letter = typeName.charAt(0).toUpperCase(); + return TYPE_LETTER_RANGES.find(range => range.letters.includes(letter)); +} - const chunks = []; - let current = ''; +// Split the types section at H3 boundaries into fixed alphabetical ranges. +function chunkByLetterRange(content) { + const parts = content.split(/(?=^### )/m); + const buckets = Object.fromEntries(TYPE_LETTER_RANGES.map(range => [range.suffix, ''])); for (const part of parts) { - if (!current) { - current = part; - } else if (Buffer.byteLength(current + part, 'utf8') > maxBytes) { - chunks.push(current); - current = part; - } else { - current += part; + const h3Match = part.match(/^### (\S+)/); + if (!h3Match) { + continue; + } + + const range = letterRangeFor(h3Match[1]); + if (!range) { + console.warn(` warning: type "${h3Match[1]}" has no letter range`); + continue; } + buckets[range.suffix] += part; } - if (current) chunks.push(current); - return chunks; + + return TYPE_LETTER_RANGES.map(range => ({ + suffix: range.suffix, + content: buckets[range.suffix] + ? (TYPES_HEADER + buckets[range.suffix]).trimEnd() + '\n' + : TYPES_HEADER, + })); } -// Replace the block at the end of an index.md with fresh entries. -// fragmentsRelPath is the relative path from the index.md's directory to the -// autogenerated includes directory (e.g. "../../includes/autogenerated"). -function updateIndexFragments(indexPath, fragmentFiles, fragmentsRelPath) { - if (!fs.existsSync(indexPath)) { - console.warn(` warning: index.md not found at ${indexPath}`); - return; - } +function yamlQuote(value) { + return JSON.stringify(value); +} - const content = fs.readFileSync(indexPath, 'utf8'); - const firstFragment = content.indexOf('`, + '', + ].join('\n'); + + fs.writeFileSync(pagePath, content, 'utf8'); +} - const fragmentBlock = fragmentFiles - .map(f => ``) - .join('\n\n'); +function schemaDescription(meta, sectionLabel) { + if (meta.version === 'saas') { + return `Review GraphQL ${sectionLabel} in the ${meta.productLabel} API schema.`; + } + return `Review GraphQL ${sectionLabel} in the ${meta.productLabel} ${meta.version} API schema.`; +} - fs.writeFileSync(indexPath, base + fragmentBlock + '\n', 'utf8'); +function syncReferencePages(indexDir, schemaMeta, pageSpecs, fragmentsRelPath) { + const indexAbsDir = path.resolve(ROOT, indexDir); + + for (const spec of pageSpecs) { + const title = spec.pageTitleSuffix + ? `${schemaMeta.titleBase}${spec.pageTitleSuffix}` + : schemaMeta.titleBase; + const description = spec.description(schemaMeta); + const heading = spec.heading(schemaMeta); + const pagePath = path.join(indexAbsDir, spec.pageFile); + + writeReferencePage(pagePath, { + title, + description, + heading, + fragmentFile: spec.fragmentFile, + fragmentsRelPath, + }); + console.log(` updated ${path.join(indexDir, spec.pageFile)}`); + } } // To add a new schema version: add an entry here and a matching config YAML, // then add a generate:graphql-api-docs:X-Y-Z script to package.json. const schemas = [ - { version: '2.4.9', config: 'spectaql/config.yml', indexDir: 'src/pages/reference/graphql' }, - { version: '2.4.6', config: 'spectaql/config_2-4-6.yml', indexDir: 'src/pages/reference/graphql/2-4-6' }, - { version: '2.4.7', config: 'spectaql/config_2-4-7.yml', indexDir: 'src/pages/reference/graphql/2-4-7' }, - { version: '2.4.8', config: 'spectaql/config_2-4-8.yml', indexDir: 'src/pages/reference/graphql/2-4-8' }, - { version: 'saas', config: 'spectaql/config_saas.yml', indexDir: 'src/pages/reference/graphql/saas' }, + { + version: '2.4.9', + config: 'spectaql/config.yml', + indexDir: 'src/pages/reference/graphql/latest', + titleBase: 'GraphQL API reference (2.4.9)', + headingBase: 'Adobe Commerce GraphQL API', + productLabel: 'Adobe Commerce', + }, + { + version: '2.4.8', + config: 'spectaql/config_2-4-8.yml', + indexDir: 'src/pages/reference/graphql/2-4-8', + titleBase: 'GraphQL API reference (2.4.8)', + headingBase: 'Adobe Commerce GraphQL API (2.4.8)', + productLabel: 'Adobe Commerce', + }, + { + version: '2.4.7', + config: 'spectaql/config_2-4-7.yml', + indexDir: 'src/pages/reference/graphql/2-4-7', + titleBase: 'GraphQL API reference (2.4.7)', + headingBase: 'Adobe Commerce GraphQL API (2.4.7)', + productLabel: 'Adobe Commerce', + }, + { + version: '2.4.6', + config: 'spectaql/config_2-4-6.yml', + indexDir: 'src/pages/reference/graphql/2-4-6', + titleBase: 'GraphQL API reference (2.4.6)', + headingBase: 'Adobe Commerce GraphQL API (2.4.6)', + productLabel: 'Adobe Commerce', + }, + { + version: 'saas', + config: 'spectaql/config_saas.yml', + indexDir: 'src/pages/reference/graphql/saas', + titleBase: 'GraphQL API reference (SaaS)', + headingBase: 'Adobe Commerce as a Cloud Service GraphQL API', + productLabel: 'Adobe Commerce as a Cloud Service', + }, ]; // Optional version filter passed as the first CLI argument. @@ -129,7 +209,8 @@ if (filter && toRun.length === 0) { process.exit(1); } -for (const { config, indexDir } of toRun) { +for (const schema of toRun) { + const { config, indexDir } = schema; const configPath = path.resolve(ROOT, config); const outputFile = outputFileFor(config); const outputDir = path.dirname(outputFile); @@ -175,51 +256,73 @@ for (const { config, indexDir } of toRun) { fs.unlinkSync(outputFile); const sections = parseSections(content); - const generatedFiles = []; + const pageSpecs = []; // Queries file: preamble (endpoint/header boilerplate) + queries section. { - const fileName = `${baseName}-queries.md`; + const fragmentFile = `${baseName}-queries.md`; const body = ((sections.preamble || '') + (sections.queries || '')).trimEnd() + '\n'; - fs.writeFileSync(path.join(outputDir, fileName), body, 'utf8'); - generatedFiles.push(fileName); - console.log(` wrote ${fileName}`); + fs.writeFileSync(path.join(outputDir, fragmentFile), body, 'utf8'); + console.log(` wrote ${fragmentFile}`); + pageSpecs.push({ + pageFile: 'index.md', + fragmentFile, + pageTitleSuffix: '', + heading: meta => meta.headingBase, + description: meta => schemaDescription(meta, 'queries'), + }); } // Mutations section. if (sections.mutations) { - const fileName = `${baseName}-mutations.md`; - fs.writeFileSync(path.join(outputDir, fileName), sections.mutations.trimEnd() + '\n', 'utf8'); - generatedFiles.push(fileName); - console.log(` wrote ${fileName}`); + const fragmentFile = `${baseName}-mutations.md`; + fs.writeFileSync(path.join(outputDir, fragmentFile), sections.mutations.trimEnd() + '\n', 'utf8'); + console.log(` wrote ${fragmentFile}`); + pageSpecs.push({ + pageFile: 'mutations.md', + fragmentFile, + pageTitleSuffix: ' – Mutations', + heading: () => 'Mutations', + description: meta => schemaDescription(meta, 'mutations'), + }); } // Subscriptions section (not present in current schemas, included for // forward-compatibility). if (sections.subscriptions) { - const fileName = `${baseName}-subscriptions.md`; - fs.writeFileSync(path.join(outputDir, fileName), sections.subscriptions.trimEnd() + '\n', 'utf8'); - generatedFiles.push(fileName); - console.log(` wrote ${fileName}`); + const fragmentFile = `${baseName}-subscriptions.md`; + fs.writeFileSync(path.join(outputDir, fragmentFile), sections.subscriptions.trimEnd() + '\n', 'utf8'); + console.log(` wrote ${fragmentFile}`); + pageSpecs.push({ + pageFile: 'subscriptions.md', + fragmentFile, + pageTitleSuffix: ' – Subscriptions', + heading: () => 'Subscriptions', + description: meta => schemaDescription(meta, 'subscriptions'), + }); } - // Types section: split into ≤200 KB chunks at H3 boundaries. + // Types section: split into fixed alphabetical ranges. if (sections.types) { - const chunks = chunkByH3(sections.types, MAX_TYPES_CHUNK_BYTES); - for (let i = 0; i < chunks.length; i++) { - const fileName = `${baseName}-types-${i + 1}.md`; - fs.writeFileSync(path.join(outputDir, fileName), chunks[i].trimEnd() + '\n', 'utf8'); - generatedFiles.push(fileName); - console.log(` wrote ${fileName}`); + const chunks = chunkByLetterRange(sections.types); + for (const chunk of chunks) { + const range = TYPE_LETTER_RANGES.find(entry => entry.suffix === chunk.suffix); + const fragmentFile = `${baseName}-types-${chunk.suffix}.md`; + fs.writeFileSync(path.join(outputDir, fragmentFile), chunk.content, 'utf8'); + console.log(` wrote ${fragmentFile}`); + pageSpecs.push({ + pageFile: `types-${chunk.suffix}.md`, + fragmentFile, + pageTitleSuffix: ` – ${range.navTitle}`, + heading: () => range.heading, + description: meta => schemaDescription(meta, range.navTitle.toLowerCase()), + }); } } - // Sync the Fragment includes in the corresponding reference index page. - const indexPath = path.resolve(ROOT, indexDir, 'index.md'); const autogeneratedDir = path.resolve(ROOT, 'src/pages/includes/autogenerated'); const fragmentsRelPath = path.relative(path.resolve(ROOT, indexDir), autogeneratedDir); - updateIndexFragments(indexPath, generatedFiles, fragmentsRelPath); - console.log(` updated ${indexDir}/index.md`); + syncReferencePages(indexDir, schema, pageSpecs, fragmentsRelPath); - console.log(`Done: ${generatedFiles.length} chunk files for ${baseName}\n`); + console.log(`Done: ${pageSpecs.length} reference pages for ${baseName}\n`); } diff --git a/spectaql/README.md b/spectaql/README.md index 2c28e21c1..dded76242 100644 --- a/spectaql/README.md +++ b/spectaql/README.md @@ -23,20 +23,25 @@ This directory contains [SpectaQL](https://github.com/anvilco/spectaql) configur | `schema_saas.json` | GraphQL introspection result — Adobe Commerce as a Cloud Service. | | `markdown-theme/` | Custom SpectaQL Handlebars theme that outputs a plain Markdown fragment instead of HTML. | | `markdown-grunt-config.js` | Custom grunt task config that disables SpectaQL's HTML prettifier, which would otherwise collapse the Markdown output to a single line. | -| `scripts/generate-spectaql-md.js` | Build script. Runs SpectaQL once per schema, splits the output into per-section chunk files, removes SpectaQL's JS/CSS asset output, and syncs the Fragment includes in the corresponding `index.md`. | +| `scripts/generate-spectaql-md.js` | Build script. Runs SpectaQL once per schema, splits the output into per-section chunk files, removes SpectaQL's JS/CSS asset output, and syncs the reference pages that embed each chunk via a single Fragment include. | ## How it works -The script reads each local introspection file, runs SpectaQL with a custom Markdown-output theme, and splits the monolithic output into smaller chunk files written to `src/pages/includes/autogenerated/`. Each generated chunk is included in the API reference page via Fragment directives that the script maintains automatically: +The script reads each local introspection file, runs SpectaQL with a custom Markdown-output theme, and splits the monolithic output into smaller chunk files written to `src/pages/includes/autogenerated/`. Each chunk is embedded in its own reference page via a single Fragment directive that the script maintains automatically: ```html + + + - + + + … ``` -The deployment system imposes a size limit on individual Markdown files, so the types section is split into multiple chunks of at most ~200 KB each (split at type boundaries, never mid-entry). +The deployment system imposes a size limit on individual Markdown files, and loading every chunk on one page defeats the purpose of splitting. Types are therefore split into fixed alphabetical ranges (`types-a-b`, `types-c-e`, `types-f-i`, `types-k-p`, `types-q-s`, `types-t-z`), each mapped to its own reference page. Queries and mutations are separate pages as well. ## Generate the API reference @@ -64,8 +69,8 @@ What happens for each schema: 1. The custom `markdown-grunt-config.js` bypasses the HTML prettifier. 1. SpectaQL's JS/CSS asset directories are removed from the output directory. 1. The document is split by H2 section into `*-queries.md`, `*-mutations.md`, and (if present) `*-subscriptions.md`. -1. The types section is further split into `*-types-1.md`, `*-types-2.md`, … at H3 boundaries so each chunk stays under ~200 KB. -1. The `` block in the corresponding `index.md` under `src/pages/reference/graphql/` is rewritten to reference exactly the generated chunk files. +1. The types section is split into fixed alphabetical ranges: `*-types-a-b.md`, `*-types-c-e.md`, `*-types-f-i.md`, `*-types-k-p.md`, `*-types-q-s.md`, and `*-types-t-z.md` (split at H3 boundaries). +1. The script writes or updates separate reference pages under `src/pages/reference/graphql/` (`index.md`, `mutations.md`, and `types-*.md`) so each page embeds exactly one chunk file. ## Update the API reference @@ -78,8 +83,8 @@ If a schema changes: npm run generate:graphql-api-docs:X.Y.Z ``` -1. Review the updated chunk files in `src/pages/includes/autogenerated/` and the updated `index.md` in its corresponding `src/pages/reference/graphql/` directory. -1. Commit all changed files (chunk files + `index.md` if the number of types chunks changed). +1. Review the updated chunk files in `src/pages/includes/autogenerated/` and the updated reference pages in the corresponding `src/pages/reference/graphql/` directory. +1. Commit all changed files (chunk files + reference pages if the page layout changed). 1. After the PR is approved and merged, the updated reference is published automatically via EDS. ## Add a new schema version @@ -88,7 +93,8 @@ If a schema changes: 1. Copy `config_2-4-8.yml` to `config_X.Y.Z.yml` and update `introspectionFile`, `targetFile`, `version`, and `title`. 1. Add an entry (with `version`, `config`, and `indexDir` fields) to the `schemas` array in `scripts/generate-spectaql-md.js`. 1. Add a `generate:graphql-api-docs:X.Y.Z` script to `package.json`. -1. Create `src/pages/reference/graphql/X-Y-Z/index.md` with the appropriate frontmatter, Edition badge, and heading (no Fragment lines needed — the script writes them on first run). +1. Create `src/pages/reference/graphql/X-Y-Z/index.md` with the appropriate frontmatter and heading (no Fragment lines needed — the script writes the reference pages on first run). +1. Add the version's sub-pages to `src/pages/config.md` (queries, mutations, and the six types ranges). 1. Run `npm run generate:graphql-api-docs:X.Y.Z` and commit the result. ## Notes From 2d836b728a7fa49c2100b0f3a31bc0e70906adb7 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 22 Jun 2026 15:45:12 -0500 Subject: [PATCH 02/10] docs(reference)!: paginate GraphQL API reference for all schema versions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Split each schema version into queries, mutations, and six alphabetical type pages so no single page embeds the full ~950 KB reference. Move the default 2.4.9 reference from /reference/graphql/ to /reference/graphql/latest/. Add sub-page navigation in config.md for SaaS, latest (2.4.9), 2.4.8, 2.4.7, and 2.4.6. Update schema guide cross-links to the new latest path. BREAKING CHANGE: 2.4.9 GraphQL API reference URLs move from /reference/graphql/ to /reference/graphql/latest/ (for example /reference/graphql/index.md → /reference/graphql/latest/index.md). External deep links to the old path will 404 unless redirects are added. --- src/pages/config.md | 49 +- .../mutations/add-products-new-cart.md | 4 +- src/pages/graphql/reference/index.md | 2 +- .../schema/attributes/interfaces/index.md | 8 +- .../attributes/queries/attributes-form.md | 2 +- .../attributes/queries/attributes-list.md | 2 +- .../queries/custom-attribute-metadata-v2.md | 2 +- .../queries/custom-attribute-metadata.md | 2 +- .../b2b/company/mutations/create-role.md | 2 +- .../b2b/company/mutations/create-team.md | 2 +- .../b2b/company/mutations/create-user.md | 2 +- .../schema/b2b/company/mutations/create.md | 2 +- .../b2b/company/mutations/delete-role.md | 2 +- .../b2b/company/mutations/delete-team.md | 2 +- .../b2b/company/mutations/delete-user.md | 2 +- .../b2b/company/mutations/update-role.md | 2 +- .../b2b/company/mutations/update-structure.md | 2 +- .../b2b/company/mutations/update-team.md | 2 +- .../b2b/company/mutations/update-user.md | 2 +- .../schema/b2b/company/mutations/update.md | 2 +- .../schema/b2b/company/queries/company.md | 2 +- .../is-company-admin-email-available.md | 2 +- .../queries/is-company-email-available.md | 2 +- .../queries/is-company-role-name-available.md | 2 +- .../is-company-user-email-available.md | 2 +- .../b2b/company/unions/structure-entity.md | 2 +- .../b2b/negotiable-quote/interfaces/index.md | 10 +- .../b2b/negotiable-quote/mutations/close.md | 2 +- .../b2b/negotiable-quote/mutations/delete.md | 2 +- .../negotiable-quote/mutations/place-order.md | 2 +- .../mutations/remove-items.md | 2 +- .../b2b/negotiable-quote/mutations/request.md | 2 +- .../mutations/send-for-review.md | 2 +- .../mutations/set-billing-address.md | 2 +- .../mutations/set-payment-method.md | 2 +- .../mutations/set-shipping-address.md | 2 +- .../mutations/set-shipping-methods.md | 2 +- .../mutations/update-quantities.md | 2 +- .../b2b/negotiable-quote/queries/quote.md | 2 +- .../b2b/negotiable-quote/queries/quotes.md | 2 +- .../b2b/negotiable-quote/queries/templates.md | 2 +- .../b2b/negotiable-quote/unions/index.md | 10 +- .../schema/b2b/purchase-order-rule/index.md | 2 +- .../purchase-order-rule/interfaces/index.md | 6 +- .../purchase-order-rule/mutations/create.md | 2 +- .../purchase-order-rule/mutations/delete.md | 2 +- .../purchase-order-rule/mutations/update.md | 2 +- .../purchase-order-rule/mutations/validate.md | 2 +- .../purchase-order/mutations/add-comment.md | 2 +- .../mutations/add-items-to-cart.md | 2 +- .../b2b/purchase-order/mutations/approve.md | 2 +- .../b2b/purchase-order/mutations/cancel.md | 2 +- .../purchase-order/mutations/place-order.md | 2 +- .../mutations/place-purchase-order.md | 2 +- .../b2b/purchase-order/mutations/reject.md | 2 +- .../b2b/requisition-list/interfaces/index.md | 14 +- .../b2b/requisition-list/interfaces/item.md | 14 +- .../mutations/add-items-to-cart.md | 2 +- .../mutations/add-products.md | 2 +- .../mutations/clear-customer-cart.md | 2 +- .../requisition-list/mutations/copy-items.md | 2 +- .../b2b/requisition-list/mutations/create.md | 2 +- .../mutations/delete-items.md | 2 +- .../b2b/requisition-list/mutations/delete.md | 2 +- .../requisition-list/mutations/move-items.md | 2 +- .../mutations/update-items.md | 2 +- .../b2b/requisition-list/mutations/update.md | 2 +- .../graphql/schema/cart/interfaces/index.md | 14 +- .../cart/mutations/add-bundle-products.md | 2 +- .../mutations/add-configurable-products.md | 2 +- .../mutations/add-downloadable-products.md | 2 +- .../schema/cart/mutations/add-products.md | 2 +- .../cart/mutations/add-simple-products.md | 2 +- .../cart/mutations/add-virtual-products.md | 2 +- .../schema/cart/mutations/apply-coupon.md | 2 +- .../schema/cart/mutations/apply-coupons.md | 2 +- .../schema/cart/mutations/apply-giftcard.md | 2 +- .../cart/mutations/apply-reward-points.md | 2 +- .../cart/mutations/apply-store-credit.md | 2 +- .../assign-customer-to-guest-cart.md | 2 +- .../schema/cart/mutations/clear-cart.md | 2 +- .../cart/mutations/create-empty-cart.md | 2 +- .../cart/mutations/create-guest-cart.md | 2 +- .../mutations/estimate-shipping-methods.md | 2 +- .../schema/cart/mutations/estimate-totals.md | 2 +- .../graphql/schema/cart/mutations/merge.md | 2 +- .../schema/cart/mutations/place-order.md | 2 +- .../cart/mutations/redeem-giftcard-balance.md | 2 +- .../schema/cart/mutations/remove-coupon.md | 2 +- .../schema/cart/mutations/remove-coupons.md | 2 +- .../schema/cart/mutations/remove-giftcard.md | 2 +- .../schema/cart/mutations/remove-item.md | 2 +- .../cart/mutations/remove-reward-points.md | 2 +- .../cart/mutations/remove-store-credit.md | 2 +- .../cart/mutations/set-billing-address.md | 2 +- .../schema/cart/mutations/set-gift-options.md | 2 +- .../schema/cart/mutations/set-guest-email.md | 2 +- .../cart/mutations/set-payment-method.md | 2 +- .../cart/mutations/set-payment-place-order.md | 2 +- .../cart/mutations/set-shipping-address.md | 2 +- .../cart/mutations/set-shipping-method.md | 2 +- .../schema/cart/mutations/update-items.md | 2 +- src/pages/graphql/schema/cart/queries/cart.md | 4 +- .../graphql/schema/cart/queries/index.md | 2 +- .../schema/cart/queries/pickup-locations.md | 2 +- .../create-braintree-client-token.md | 2 +- .../mutations/create-payflow-pro-token.md | 2 +- .../mutations/create-paypal-express-token.md | 2 +- .../mutations/delete-payment-token.md | 2 +- .../mutations/handle-payflow-pro-response.md | 2 +- .../schema/checkout/queries/agreements.md | 2 +- .../queries/customer-payment-tokens.md | 2 +- .../checkout/queries/get-hosted-pro-url.md | 2 +- .../queries/get-payflow-link-token.md | 2 +- src/pages/graphql/schema/customer/index.md | 2 +- .../customer/mutations/assign-compare-list.md | 2 +- .../customer/mutations/change-password.md | 2 +- .../customer/mutations/confirm-email.md | 2 +- .../customer/mutations/create-address.md | 2 +- .../schema/customer/mutations/create-v2.md | 2 +- .../schema/customer/mutations/create.md | 2 +- .../customer/mutations/delete-address.md | 2 +- .../mutations/generate-token-as-admin.md | 2 +- .../customer/mutations/generate-token.md | 2 +- .../mutations/request-password-reset-email.md | 2 +- .../mutations/resend-confirmation-email.md | 2 +- .../customer/mutations/reset-password.md | 2 +- .../schema/customer/mutations/revoke-token.md | 2 +- .../mutations/send-email-to-friend.md | 2 +- .../subscribe-email-to-newsletter.md | 2 +- .../customer/mutations/update-address.md | 2 +- .../schema/customer/mutations/update-email.md | 2 +- .../schema/customer/mutations/update-v2.md | 2 +- .../schema/customer/mutations/update.md | 2 +- .../graphql/schema/customer/queries/cart.md | 2 +- .../schema/customer/queries/customer.md | 2 +- .../customer/queries/downloadable-products.md | 2 +- .../customer/queries/giftcard-account.md | 2 +- .../customer/queries/is-email-available.md | 2 +- .../graphql/schema/customer/queries/orders.md | 2 +- .../mutations/add-registrants.md | 2 +- .../schema/gift-registry/mutations/create.md | 2 +- .../mutations/move-cart-items.md | 2 +- .../gift-registry/mutations/remove-items.md | 2 +- .../mutations/remove-registrants.md | 2 +- .../schema/gift-registry/mutations/remove.md | 2 +- .../schema/gift-registry/mutations/share.md | 2 +- .../gift-registry/mutations/update-items.md | 2 +- .../mutations/update-registrants.md | 2 +- .../schema/gift-registry/mutations/update.md | 2 +- .../gift-registry/queries/email-search.md | 2 +- .../gift-registry/queries/gift-registry.md | 2 +- .../schema/gift-registry/queries/id-search.md | 2 +- .../gift-registry/queries/type-search.md | 2 +- .../schema/gift-registry/queries/types.md | 2 +- .../orders/interfaces/credit-memo-item.md | 2 +- .../schema/orders/interfaces/invoice-item.md | 2 +- .../schema/orders/interfaces/order-item.md | 2 +- .../schema/orders/interfaces/shipment-item.md | 2 +- .../orders/mutations/add-return-comment.md | 2 +- .../orders/mutations/add-return-tracking.md | 2 +- .../schema/orders/mutations/cancel-order.md | 2 +- .../orders/mutations/confirm-cancel-order.md | 2 +- .../schema/orders/mutations/confirm-return.md | 2 +- .../mutations/remove-return-tracking.md | 2 +- .../schema/orders/mutations/reorder-items.md | 2 +- .../mutations/request-guest-order-cancel.md | 2 +- .../orders/mutations/request-guest-return.md | 2 +- .../schema/orders/mutations/request-return.md | 2 +- .../orders/queries/guest-order-by-token.md | 2 +- .../schema/orders/queries/guest-order.md | 2 +- .../schema/products/interfaces/attributes.md | 4 +- .../schema/products/interfaces/category.md | 2 +- .../interfaces/customizable-option.md | 2 +- .../schema/products/interfaces/index.md | 4 +- .../schema/products/interfaces/routable.md | 2 +- .../products/interfaces/types/bundle.md | 10 +- .../products/interfaces/types/configurable.md | 8 +- .../products/interfaces/types/downloadable.md | 2 +- .../products/interfaces/types/gift-card.md | 8 +- .../products/interfaces/types/grouped.md | 2 +- .../schema/products/interfaces/types/index.md | 16 +- .../products/interfaces/types/simple.md | 8 +- .../products/interfaces/types/virtual.md | 6 +- .../mutations/add-products-to-compare-list.md | 2 +- .../products/mutations/assign-compare-list.md | 2 +- .../products/mutations/create-compare-list.md | 2 +- .../products/mutations/create-review.md | 2 +- .../products/mutations/delete-compare-list.md | 2 +- .../mutations/remove-from-compare-list.md | 2 +- .../schema/products/queries/categories.md | 2 +- .../schema/products/queries/category-list.md | 2 +- .../schema/products/queries/category.md | 2 +- .../schema/products/queries/compare-list.md | 2 +- .../product-review-ratings-metadata.md | 2 +- .../schema/products/queries/products.md | 2 +- .../graphql/schema/products/queries/route.md | 2 +- .../schema/products/queries/url-resolver.md | 2 +- .../schema/store/mutations/contact-us.md | 2 +- .../schema/store/queries/available-stores.md | 2 +- .../schema/store/queries/cms-blocks.md | 2 +- .../graphql/schema/store/queries/cms-page.md | 2 +- .../graphql/schema/store/queries/countries.md | 2 +- .../graphql/schema/store/queries/country.md | 2 +- .../graphql/schema/store/queries/currency.md | 2 +- .../schema/store/queries/dynamic-blocks.md | 2 +- .../store/queries/recaptcha-form-config.md | 2 +- .../store/queries/recaptcha-v3-config.md | 2 +- .../schema/store/queries/store-config.md | 2 +- .../schema/wishlist/interfaces/wishlist.md | 2 +- .../wishlist/mutations/add-items-to-cart.md | 2 +- .../schema/wishlist/mutations/add-products.md | 2 +- .../schema/wishlist/mutations/clear.md | 2 +- .../wishlist/mutations/copy-products.md | 2 +- .../schema/wishlist/mutations/create.md | 2 +- .../schema/wishlist/mutations/delete.md | 2 +- .../wishlist/mutations/move-products.md | 2 +- .../wishlist/mutations/remove-products.md | 2 +- .../wishlist/mutations/update-products.md | 2 +- .../schema/wishlist/mutations/update.md | 2 +- .../schema/wishlist/queries/wishlist.md | 2 +- .../graphql-api-2-4-6-mutations.md | 201 +- .../graphql-api-2-4-6-queries.md | 412 +- .../graphql-api-2-4-6-types-2.md | 6128 ------------ .../graphql-api-2-4-6-types-3.md | 5818 ------------ .../graphql-api-2-4-6-types-a-b.md | 1814 ++++ ...es-1.md => graphql-api-2-4-6-types-c-e.md} | 7589 +++++++-------- .../graphql-api-2-4-6-types-f-i.md | 2134 +++++ .../graphql-api-2-4-6-types-k-p.md | 3772 ++++++++ .../graphql-api-2-4-6-types-q-s.md | 3253 +++++++ .../graphql-api-2-4-6-types-t-z.md | 1369 +++ .../graphql-api-2-4-7-mutations.md | 317 +- .../graphql-api-2-4-7-queries.md | 716 +- .../graphql-api-2-4-7-types-2.md | 6466 ------------- .../graphql-api-2-4-7-types-4.md | 2242 ----- .../graphql-api-2-4-7-types-a-b.md | 2365 +++++ ...es-1.md => graphql-api-2-4-7-types-c-e.md} | 7757 ++++++++-------- .../graphql-api-2-4-7-types-f-i.md | 2341 +++++ ...es-3.md => graphql-api-2-4-7-types-k-p.md} | 5950 +++++------- .../graphql-api-2-4-7-types-q-s.md | 4002 ++++++++ .../graphql-api-2-4-7-types-t-z.md | 1516 +++ .../graphql-api-2-4-8-mutations.md | 301 +- .../graphql-api-2-4-8-queries.md | 738 +- .../graphql-api-2-4-8-types-2.md | 6174 ------------ .../graphql-api-2-4-8-types-a-b.md | 2481 +++++ ...es-1.md => graphql-api-2-4-8-types-c-e.md} | 8250 +++++++++-------- .../graphql-api-2-4-8-types-f-i.md | 2518 +++++ ...es-3.md => graphql-api-2-4-8-types-k-p.md} | 7148 +++++--------- ...es-4.md => graphql-api-2-4-8-types-q-s.md} | 4547 +++++---- .../graphql-api-2-4-8-types-t-z.md | 1654 ++++ .../graphql-api-2-4-9-mutations.md | 322 +- .../graphql-api-2-4-9-queries.md | 780 +- .../graphql-api-2-4-9-types-2.md | 6412 ------------- .../graphql-api-2-4-9-types-4.md | 2781 ------ .../graphql-api-2-4-9-types-a-b.md | 2464 +++++ ...es-1.md => graphql-api-2-4-9-types-c-e.md} | 8071 ++++++++-------- .../graphql-api-2-4-9-types-f-i.md | 2532 +++++ ...es-3.md => graphql-api-2-4-9-types-k-p.md} | 6899 +++++--------- .../graphql-api-2-4-9-types-q-s.md | 4219 +++++++++ .../graphql-api-2-4-9-types-t-z.md | 1614 ++++ .../graphql-api-saas-mutations.md | 358 +- .../autogenerated/graphql-api-saas-queries.md | 546 +- .../autogenerated/graphql-api-saas-types-2.md | 6511 ------------- .../graphql-api-saas-types-a-b.md | 2347 +++++ ...pes-1.md => graphql-api-saas-types-c-e.md} | 8018 ++++++++-------- .../graphql-api-saas-types-f-i.md | 2720 ++++++ ...pes-3.md => graphql-api-saas-types-k-p.md} | 7543 ++++++--------- .../graphql-api-saas-types-q-s.md | 4269 +++++++++ ...pes-4.md => graphql-api-saas-types-t-z.md} | 738 +- src/pages/reference/graphql/2-4-6/index.md | 12 +- .../reference/graphql/2-4-6/mutations.md | 10 + .../reference/graphql/2-4-6/types-a-b.md | 10 + .../reference/graphql/2-4-6/types-c-e.md | 10 + .../reference/graphql/2-4-6/types-f-i.md | 10 + .../reference/graphql/2-4-6/types-k-p.md | 10 + .../reference/graphql/2-4-6/types-q-s.md | 10 + .../reference/graphql/2-4-6/types-t-z.md | 10 + src/pages/reference/graphql/2-4-7/index.md | 14 +- .../reference/graphql/2-4-7/mutations.md | 10 + .../reference/graphql/2-4-7/types-a-b.md | 10 + .../reference/graphql/2-4-7/types-c-e.md | 10 + .../reference/graphql/2-4-7/types-f-i.md | 10 + .../reference/graphql/2-4-7/types-k-p.md | 10 + .../reference/graphql/2-4-7/types-q-s.md | 10 + .../reference/graphql/2-4-7/types-t-z.md | 10 + src/pages/reference/graphql/2-4-8/index.md | 14 +- .../reference/graphql/2-4-8/mutations.md | 10 + .../reference/graphql/2-4-8/types-a-b.md | 10 + .../reference/graphql/2-4-8/types-c-e.md | 10 + .../reference/graphql/2-4-8/types-f-i.md | 10 + .../reference/graphql/2-4-8/types-k-p.md | 10 + .../reference/graphql/2-4-8/types-q-s.md | 10 + .../reference/graphql/2-4-8/types-t-z.md | 10 + src/pages/reference/graphql/index.md | 20 - src/pages/reference/graphql/latest/index.md | 10 + .../reference/graphql/latest/mutations.md | 10 + .../reference/graphql/latest/types-a-b.md | 10 + .../reference/graphql/latest/types-c-e.md | 10 + .../reference/graphql/latest/types-f-i.md | 10 + .../reference/graphql/latest/types-k-p.md | 10 + .../reference/graphql/latest/types-q-s.md | 10 + .../reference/graphql/latest/types-t-z.md | 10 + src/pages/reference/graphql/saas/index.md | 14 +- src/pages/reference/graphql/saas/mutations.md | 10 + src/pages/reference/graphql/saas/types-a-b.md | 10 + src/pages/reference/graphql/saas/types-c-e.md | 10 + src/pages/reference/graphql/saas/types-f-i.md | 10 + src/pages/reference/graphql/saas/types-k-p.md | 10 + src/pages/reference/graphql/saas/types-q-s.md | 10 + src/pages/reference/graphql/saas/types-t-z.md | 10 + 310 files changed, 85260 insertions(+), 84894 deletions(-) delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-2.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-3.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-a-b.md rename src/pages/includes/autogenerated/{graphql-api-2-4-6-types-1.md => graphql-api-2-4-6-types-c-e.md} (71%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-k-p.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-q-s.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-6-types-t-z.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-7-types-2.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-7-types-4.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-7-types-a-b.md rename src/pages/includes/autogenerated/{graphql-api-2-4-7-types-1.md => graphql-api-2-4-7-types-c-e.md} (67%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md rename src/pages/includes/autogenerated/{graphql-api-2-4-7-types-3.md => graphql-api-2-4-7-types-k-p.md} (52%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-7-types-q-s.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-7-types-t-z.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-8-types-2.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-8-types-a-b.md rename src/pages/includes/autogenerated/{graphql-api-2-4-8-types-1.md => graphql-api-2-4-8-types-c-e.md} (62%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md rename src/pages/includes/autogenerated/{graphql-api-2-4-8-types-3.md => graphql-api-2-4-8-types-k-p.md} (62%) rename src/pages/includes/autogenerated/{graphql-api-2-4-8-types-4.md => graphql-api-2-4-8-types-q-s.md} (53%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-8-types-t-z.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-9-types-2.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-9-types-4.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-9-types-a-b.md rename src/pages/includes/autogenerated/{graphql-api-2-4-9-types-1.md => graphql-api-2-4-9-types-c-e.md} (64%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md rename src/pages/includes/autogenerated/{graphql-api-2-4-9-types-3.md => graphql-api-2-4-9-types-k-p.md} (58%) create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-9-types-q-s.md create mode 100644 src/pages/includes/autogenerated/graphql-api-2-4-9-types-t-z.md delete mode 100644 src/pages/includes/autogenerated/graphql-api-saas-types-2.md create mode 100644 src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md rename src/pages/includes/autogenerated/{graphql-api-saas-types-1.md => graphql-api-saas-types-c-e.md} (73%) create mode 100644 src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md rename src/pages/includes/autogenerated/{graphql-api-saas-types-3.md => graphql-api-saas-types-k-p.md} (54%) create mode 100644 src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md rename src/pages/includes/autogenerated/{graphql-api-saas-types-4.md => graphql-api-saas-types-t-z.md} (53%) create mode 100644 src/pages/reference/graphql/2-4-6/mutations.md create mode 100644 src/pages/reference/graphql/2-4-6/types-a-b.md create mode 100644 src/pages/reference/graphql/2-4-6/types-c-e.md create mode 100644 src/pages/reference/graphql/2-4-6/types-f-i.md create mode 100644 src/pages/reference/graphql/2-4-6/types-k-p.md create mode 100644 src/pages/reference/graphql/2-4-6/types-q-s.md create mode 100644 src/pages/reference/graphql/2-4-6/types-t-z.md create mode 100644 src/pages/reference/graphql/2-4-7/mutations.md create mode 100644 src/pages/reference/graphql/2-4-7/types-a-b.md create mode 100644 src/pages/reference/graphql/2-4-7/types-c-e.md create mode 100644 src/pages/reference/graphql/2-4-7/types-f-i.md create mode 100644 src/pages/reference/graphql/2-4-7/types-k-p.md create mode 100644 src/pages/reference/graphql/2-4-7/types-q-s.md create mode 100644 src/pages/reference/graphql/2-4-7/types-t-z.md create mode 100644 src/pages/reference/graphql/2-4-8/mutations.md create mode 100644 src/pages/reference/graphql/2-4-8/types-a-b.md create mode 100644 src/pages/reference/graphql/2-4-8/types-c-e.md create mode 100644 src/pages/reference/graphql/2-4-8/types-f-i.md create mode 100644 src/pages/reference/graphql/2-4-8/types-k-p.md create mode 100644 src/pages/reference/graphql/2-4-8/types-q-s.md create mode 100644 src/pages/reference/graphql/2-4-8/types-t-z.md delete mode 100644 src/pages/reference/graphql/index.md create mode 100644 src/pages/reference/graphql/latest/index.md create mode 100644 src/pages/reference/graphql/latest/mutations.md create mode 100644 src/pages/reference/graphql/latest/types-a-b.md create mode 100644 src/pages/reference/graphql/latest/types-c-e.md create mode 100644 src/pages/reference/graphql/latest/types-f-i.md create mode 100644 src/pages/reference/graphql/latest/types-k-p.md create mode 100644 src/pages/reference/graphql/latest/types-q-s.md create mode 100644 src/pages/reference/graphql/latest/types-t-z.md create mode 100644 src/pages/reference/graphql/saas/mutations.md create mode 100644 src/pages/reference/graphql/saas/types-a-b.md create mode 100644 src/pages/reference/graphql/saas/types-c-e.md create mode 100644 src/pages/reference/graphql/saas/types-f-i.md create mode 100644 src/pages/reference/graphql/saas/types-k-p.md create mode 100644 src/pages/reference/graphql/saas/types-q-s.md create mode 100644 src/pages/reference/graphql/saas/types-t-z.md diff --git a/src/pages/config.md b/src/pages/config.md index b2980ff10..087a5d552 100644 --- a/src/pages/config.md +++ b/src/pages/config.md @@ -12,7 +12,7 @@ - GraphQL - [Guide](/graphql/index.md) - [SaaS Reference](/reference/graphql/saas/index.md) - - [2.4.9 Reference](/reference/graphql/index.md) + - [2.4.9 Reference](/reference/graphql/latest/index.md) - [2.4.8 Reference](/reference/graphql/2-4-8/index.md) - [2.4.7 Reference](/reference/graphql/2-4-7/index.md) - [2.4.6 Reference](/reference/graphql/2-4-6/index.md) @@ -532,8 +532,53 @@ - [Step 10: Place the order](/graphql/tutorials/checkout/place-order.md) - [Reference](/graphql/reference/index.md) - [SaaS](/reference/graphql/saas/index.md) - - [2.4.9](/reference/graphql/index.md) + - [2.4.9](/reference/graphql/latest/index.md) - [2.4.8](/reference/graphql/2-4-8/index.md) - [2.4.7](/reference/graphql/2-4-7/index.md) - [2.4.6](/reference/graphql/2-4-6/index.md) + - [GraphQL API reference (SaaS)](/reference/graphql/saas/index.md) + - [Queries](/reference/graphql/saas/index.md) + - [Mutations](/reference/graphql/saas/mutations.md) + - [Types A–B](/reference/graphql/saas/types-a-b.md) + - [Types C–E](/reference/graphql/saas/types-c-e.md) + - [Types F–I](/reference/graphql/saas/types-f-i.md) + - [Types K–P](/reference/graphql/saas/types-k-p.md) + - [Types Q–S](/reference/graphql/saas/types-q-s.md) + - [Types T–Z](/reference/graphql/saas/types-t-z.md) + - [GraphQL API reference (2.4.9)](/reference/graphql/latest/index.md) + - [Queries](/reference/graphql/latest/index.md) + - [Mutations](/reference/graphql/latest/mutations.md) + - [Types A–B](/reference/graphql/latest/types-a-b.md) + - [Types C–E](/reference/graphql/latest/types-c-e.md) + - [Types F–I](/reference/graphql/latest/types-f-i.md) + - [Types K–P](/reference/graphql/latest/types-k-p.md) + - [Types Q–S](/reference/graphql/latest/types-q-s.md) + - [Types T–Z](/reference/graphql/latest/types-t-z.md) + - [GraphQL API reference (2.4.8)](/reference/graphql/2-4-8/index.md) + - [Queries](/reference/graphql/2-4-8/index.md) + - [Mutations](/reference/graphql/2-4-8/mutations.md) + - [Types A–B](/reference/graphql/2-4-8/types-a-b.md) + - [Types C–E](/reference/graphql/2-4-8/types-c-e.md) + - [Types F–I](/reference/graphql/2-4-8/types-f-i.md) + - [Types K–P](/reference/graphql/2-4-8/types-k-p.md) + - [Types Q–S](/reference/graphql/2-4-8/types-q-s.md) + - [Types T–Z](/reference/graphql/2-4-8/types-t-z.md) + - [GraphQL API reference (2.4.7)](/reference/graphql/2-4-7/index.md) + - [Queries](/reference/graphql/2-4-7/index.md) + - [Mutations](/reference/graphql/2-4-7/mutations.md) + - [Types A–B](/reference/graphql/2-4-7/types-a-b.md) + - [Types C–E](/reference/graphql/2-4-7/types-c-e.md) + - [Types F–I](/reference/graphql/2-4-7/types-f-i.md) + - [Types K–P](/reference/graphql/2-4-7/types-k-p.md) + - [Types Q–S](/reference/graphql/2-4-7/types-q-s.md) + - [Types T–Z](/reference/graphql/2-4-7/types-t-z.md) + - [GraphQL API reference (2.4.6)](/reference/graphql/2-4-6/index.md) + - [Queries](/reference/graphql/2-4-6/index.md) + - [Mutations](/reference/graphql/2-4-6/mutations.md) + - [Types A–B](/reference/graphql/2-4-6/types-a-b.md) + - [Types C–E](/reference/graphql/2-4-6/types-c-e.md) + - [Types F–I](/reference/graphql/2-4-6/types-f-i.md) + - [Types K–P](/reference/graphql/2-4-6/types-k-p.md) + - [Types Q–S](/reference/graphql/2-4-6/types-q-s.md) + - [Types T–Z](/reference/graphql/2-4-6/types-t-z.md) - [Release notes](/graphql/release-notes.md) 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 index bd6fe55f8..8cf5efb23 100644 --- 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 @@ -41,7 +41,7 @@ These examples show when the `addProductsToNewCart` mutation returns a successfu ### Create a new cart (success) -The following example adds a simple product to a new cart successfully, returning a [Cart](/reference/graphql/index.md#cart) object. +The following example adds a simple product to a new cart successfully, returning a [Cart](/reference/graphql/latest/index.md#cart) object. **Request:** @@ -83,7 +83,7 @@ mutation { ### 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](/reference/graphql/index.md#cartuserinputerror) object. +The following example fails to create a new cart beccause the `sku` does not exist in the catalog. It returns a [CartUserInputError](/reference/graphql/latest/index.md#cartuserinputerror) object. **Request:** diff --git a/src/pages/graphql/reference/index.md b/src/pages/graphql/reference/index.md index 43e2896c2..0e04daf59 100644 --- a/src/pages/graphql/reference/index.md +++ b/src/pages/graphql/reference/index.md @@ -12,7 +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: * [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [GraphQL API reference](../../reference/graphql/saas/index.md) -* [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [2.4.9 GraphQL API reference](../../reference/graphql/index.md) +* [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [2.4.9 GraphQL API reference](../../reference/graphql/latest/index.md) * [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [2.4.8 GraphQL API reference](../../reference/graphql/2-4-8/index.md) * [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [2.4.7 GraphQL API reference](../../reference/graphql/2-4-7/index.md) * [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [2.4.6 GraphQL API reference](../../reference/graphql/2-4-6/index.md) diff --git a/src/pages/graphql/schema/attributes/interfaces/index.md b/src/pages/graphql/schema/attributes/interfaces/index.md index 02bc4b307..1af10811e 100644 --- a/src/pages/graphql/schema/attributes/interfaces/index.md +++ b/src/pages/graphql/schema/attributes/interfaces/index.md @@ -9,10 +9,10 @@ Adobe Commerce on cloud and on-premises (PaaS) provides the following interfaces | Interface | Implementations | | --- | --- | -| [`AttributeSelectedOptionInterface`](/reference/graphql/index.md#attributeselectedoptioninterface) | [`AttributeSelectedOption`](/reference/graphql/index.md#attributeselectedoption) | -| [`AttributeValueInterface`](/reference/graphql/index.md#attributevalueinterface) | [`AttributeValue`](/reference/graphql/index.md#attributevalue) \
[`AttributeSelectedOptions`](/reference/graphql/index.md#attributeselectedoptions) | -| [`CustomAttributeMetadataInterface`](/reference/graphql/index.md#customerattributemetadata) | [`AttributeMetadata`](/reference/graphql/index.md#attributemetadata) | -| [`CustomAttributeOptionInterface`](/reference/graphql/index.md#customattributeoptioninterface) | [`AttributeOptionMetadata`](/reference/graphql/index.md#attributeoptionmetadata). | +| [`AttributeSelectedOptionInterface`](/reference/graphql/latest/index.md#attributeselectedoptioninterface) | [`AttributeSelectedOption`](/reference/graphql/latest/index.md#attributeselectedoption) | +| [`AttributeValueInterface`](/reference/graphql/latest/index.md#attributevalueinterface) | [`AttributeValue`](/reference/graphql/latest/index.md#attributevalue) \
[`AttributeSelectedOptions`](/reference/graphql/latest/index.md#attributeselectedoptions) | +| [`CustomAttributeMetadataInterface`](/reference/graphql/latest/index.md#customerattributemetadata) | [`AttributeMetadata`](/reference/graphql/latest/index.md#attributemetadata) | +| [`CustomAttributeOptionInterface`](/reference/graphql/latest/index.md#customattributeoptioninterface) | [`AttributeOptionMetadata`](/reference/graphql/latest/index.md#attributeoptionmetadata). | The following table lists the same interfaces and implementations with links to the **Adobe Commerce as a Cloud Service (SaaS)** GraphQL reference. diff --git a/src/pages/graphql/schema/attributes/queries/attributes-form.md b/src/pages/graphql/schema/attributes/queries/attributes-form.md index b89e793d6..b6b277bd6 100644 --- a/src/pages/graphql/schema/attributes/queries/attributes-form.md +++ b/src/pages/graphql/schema/attributes/queries/attributes-form.md @@ -36,7 +36,7 @@ The `attributesForm` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#attributesform) -* [On-Premises/Cloud](/reference/graphql/index.md#attributesform) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#attributesform) ## Example usage diff --git a/src/pages/graphql/schema/attributes/queries/attributes-list.md b/src/pages/graphql/schema/attributes/queries/attributes-list.md index b4cf80d88..dee9836fd 100644 --- a/src/pages/graphql/schema/attributes/queries/attributes-list.md +++ b/src/pages/graphql/schema/attributes/queries/attributes-list.md @@ -19,7 +19,7 @@ The `attributesList` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#attributeslist) -* [On-Premises/Cloud](/reference/graphql/index.md#attributeslist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#attributeslist) ## Example usage diff --git a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md index fa628fd76..c72a9f82f 100644 --- a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md +++ b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata-v2.md @@ -24,7 +24,7 @@ The `customAttributeMetadataV2` reference provides detailed information about th - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customattributemetadatav2) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#customattributemetadatav2) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#customattributemetadatav2) ## Example usage diff --git a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md index 5dc72d6cc..3b0e2e1e6 100644 --- a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md +++ b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md @@ -21,7 +21,7 @@ The `StorefrontProperties` output object returns information about a product att The `customAttributeMetadata` reference provides detailed information about the types and fields defined in this query. -* [On-Premises/Cloud](/reference/graphql/index.md#customattributemetadata) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#customattributemetadata) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create-role.md b/src/pages/graphql/schema/b2b/company/mutations/create-role.md index a4db5ec84..241b73a51 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create-role.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create-role.md @@ -35,7 +35,7 @@ The `createCompanyRole` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompanyrole) -* [On-Premises/Cloud](/reference/graphql/index.md#createcompanyrole) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompanyrole) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create-team.md b/src/pages/graphql/schema/b2b/company/mutations/create-team.md index 2c5e2377b..eb22024f9 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create-team.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create-team.md @@ -35,7 +35,7 @@ The `createCompanyTeam` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompanyteam) -* [On-Premises/Cloud](/reference/graphql/index.md#createcompanyteam) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompanyteam) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create-user.md b/src/pages/graphql/schema/b2b/company/mutations/create-user.md index 6691e7950..0520f4a43 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create-user.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create-user.md @@ -41,7 +41,7 @@ The `createCompanyUser` reference provides detailed information about the types - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompanyuser) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#createcompanyuser) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompanyuser) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create.md b/src/pages/graphql/schema/b2b/company/mutations/create.md index 33026be1a..aa97566f0 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create.md @@ -31,7 +31,7 @@ The `createCompany` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompany) -* [On-Premises/Cloud](/reference/graphql/index.md#createcompany) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompany) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/delete-role.md b/src/pages/graphql/schema/b2b/company/mutations/delete-role.md index f760f05ff..2ed753aa7 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/delete-role.md +++ b/src/pages/graphql/schema/b2b/company/mutations/delete-role.md @@ -33,7 +33,7 @@ The `deleteCompanyRole` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecompanyrole) -* [On-Premises/Cloud](/reference/graphql/index.md#deletecompanyrole) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecompanyrole) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/delete-team.md b/src/pages/graphql/schema/b2b/company/mutations/delete-team.md index 00491229f..80e8cfd44 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/delete-team.md +++ b/src/pages/graphql/schema/b2b/company/mutations/delete-team.md @@ -31,7 +31,7 @@ The `deleteCompanyTeam` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecompanyteam) -* [On-Premises/Cloud](/reference/graphql/index.md#deletecompanyteam) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecompanyteam) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/delete-user.md b/src/pages/graphql/schema/b2b/company/mutations/delete-user.md index 6e2ce713f..e49330dae 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/delete-user.md +++ b/src/pages/graphql/schema/b2b/company/mutations/delete-user.md @@ -31,7 +31,7 @@ mutation { ## Reference -The [`deleteCompanyUser`](/reference/graphql/index.md#deletecompanyuser) reference provides detailed information about the types and fields defined in this mutation. +The [`deleteCompanyUser`](/reference/graphql/latest/index.md#deletecompanyuser) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-role.md b/src/pages/graphql/schema/b2b/company/mutations/update-role.md index 413bda913..cb9a4da6f 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-role.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-role.md @@ -41,7 +41,7 @@ The `updateCompanyRole` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanyrole) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecompanyrole) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanyrole) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-structure.md b/src/pages/graphql/schema/b2b/company/mutations/update-structure.md index 2b0e419f4..5dbc3e162 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-structure.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-structure.md @@ -31,7 +31,7 @@ The `updateCompanyStructure` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanystructure) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecompanystructure) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanystructure) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-team.md b/src/pages/graphql/schema/b2b/company/mutations/update-team.md index e975a3639..b60e8e9ce 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-team.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-team.md @@ -31,7 +31,7 @@ The `updateCompanyTeam` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanyteam) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecompanyteam) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanyteam) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-user.md b/src/pages/graphql/schema/b2b/company/mutations/update-user.md index 820a611f9..5526b050a 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-user.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-user.md @@ -33,7 +33,7 @@ The `updateCompanyUser` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanyuser) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecompanyuser) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanyuser) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update.md b/src/pages/graphql/schema/b2b/company/mutations/update.md index c6178eac9..f8d008082 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update.md @@ -31,7 +31,7 @@ The `updateCompany` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompany) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecompany) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompany) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/company.md b/src/pages/graphql/schema/b2b/company/queries/company.md index c087384f1..9b6869b1a 100644 --- a/src/pages/graphql/schema/b2b/company/queries/company.md +++ b/src/pages/graphql/schema/b2b/company/queries/company.md @@ -27,7 +27,7 @@ The `company` reference provides detailed information about the types and fields * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#company) -* [On-Premises/Cloud](/reference/graphql/index.md#company) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#company) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/is-company-admin-email-available.md b/src/pages/graphql/schema/b2b/company/queries/is-company-admin-email-available.md index 7e731590b..0a7403694 100644 --- a/src/pages/graphql/schema/b2b/company/queries/is-company-admin-email-available.md +++ b/src/pages/graphql/schema/b2b/company/queries/is-company-admin-email-available.md @@ -23,7 +23,7 @@ The `isCompanyAdminEmailAvailable` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#iscompanyadminemailavailable) -* [On-Premises/Cloud](/reference/graphql/index.md#iscompanyadminemailavailable) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#iscompanyadminemailavailable) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/is-company-email-available.md b/src/pages/graphql/schema/b2b/company/queries/is-company-email-available.md index d3c22d0f9..910863559 100644 --- a/src/pages/graphql/schema/b2b/company/queries/is-company-email-available.md +++ b/src/pages/graphql/schema/b2b/company/queries/is-company-email-available.md @@ -23,7 +23,7 @@ The `isCompanyEmailAvailable` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#iscompanyemailavailable) -* [On-Premises/Cloud](/reference/graphql/index.md#iscompanyemailavailable) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#iscompanyemailavailable) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/is-company-role-name-available.md b/src/pages/graphql/schema/b2b/company/queries/is-company-role-name-available.md index 946c7adb3..58a964647 100644 --- a/src/pages/graphql/schema/b2b/company/queries/is-company-role-name-available.md +++ b/src/pages/graphql/schema/b2b/company/queries/is-company-role-name-available.md @@ -33,7 +33,7 @@ The `isCompanyRoleNameAvailable` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#iscompanyrolenameavailable) -* [On-Premises/Cloud](/reference/graphql/index.md#iscompanyrolenameavailable) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#iscompanyrolenameavailable) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/is-company-user-email-available.md b/src/pages/graphql/schema/b2b/company/queries/is-company-user-email-available.md index ac3ebfafc..23602255d 100644 --- a/src/pages/graphql/schema/b2b/company/queries/is-company-user-email-available.md +++ b/src/pages/graphql/schema/b2b/company/queries/is-company-user-email-available.md @@ -23,7 +23,7 @@ The `isCompanyUserEmailAvailable` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#iscompanyuseremailavailable) -* [On-Premises/Cloud](/reference/graphql/index.md#iscompanyuseremailavailable) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#iscompanyuseremailavailable) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/unions/structure-entity.md b/src/pages/graphql/schema/b2b/company/unions/structure-entity.md index 42b05c3da..76205ea8e 100644 --- a/src/pages/graphql/schema/b2b/company/unions/structure-entity.md +++ b/src/pages/graphql/schema/b2b/company/unions/structure-entity.md @@ -21,7 +21,7 @@ The `CompanyStructureEntity` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#companystructureentity) -* [On-Premises/Cloud](/reference/graphql/index.md#companystructureentity) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#companystructureentity) **Possible types:** diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md b/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md index 017d955c7..a474c48e1 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md @@ -15,28 +15,28 @@ Negotiable quote queries and mutations can access the following interfaces: * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteaddressinterface) - * [On-Premises/Cloud](/reference/graphql/index.md#negotiablequoteaddressinterface) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteaddressinterface) It is implemented by `NegotiableQuoteShippingAddress` * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteshippingaddress) - * [On-Premises/Cloud](/reference/graphql/index.md#negotiablequoteshippingaddress) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteshippingaddress) and `NegotiableQuoteBillingAddress` * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequotebillingaddress) - * [On-Premises/Cloud](/reference/graphql/index.md#negotiablequotebillingaddress) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequotebillingaddress) * `NegotiableQuoteUidNonFatalResultInterface` * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteuidnonfatalresultinterface) - * [On-Premises/Cloud](/reference/graphql/index.md#negotiablequoteuidnonfatalresultinterface) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteuidnonfatalresultinterface) It is implemented by `NegotiableQuoteUidOperationSuccess` * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteuidoperationsuccess) - * [On-Premises/Cloud](/reference/graphql/index.md#negotiablequoteuidoperationsuccess) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteuidoperationsuccess) diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md index e42ca7dad..52f072f51 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md @@ -35,7 +35,7 @@ The `closeNegotiableQuotes` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#closenegotiablequotes) -* [On-Premises/Cloud](/reference/graphql/index.md#closenegotiablequotes) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#closenegotiablequotes) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md index facdca352..06a643023 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md @@ -36,7 +36,7 @@ The `deleteNegotiableQuotes` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletenegotiablequotes) -* [On-Premises/Cloud](/reference/graphql/index.md#deletenegotiablequotes) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletenegotiablequotes) The [`DeleteNegotiableQuoteOperationResult` union](../unions/index.md) is an output object that provides details about the result of a request to delete a negotiable quote. To return these details, specify fragments on the `DeleteNegotiableQuoteOperationFailure` and `NegotiableQuoteUidOperationSuccess` objects. Specify the `__typename` attribute to distinguish the object types in the response. 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 7bf8d49cf..2af5955e0 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 @@ -53,7 +53,7 @@ The `placeNegotiableQuoteOrder` reference provides detailed information about th - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placenegotiablequoteorder) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#placenegotiablequoteorder) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#placenegotiablequoteorder) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md index 0d47befb3..181a377b5 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md @@ -31,7 +31,7 @@ The `removeNegotiableQuoteItems` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removenegotiablequoteitems) -* [On-Premises/Cloud](/reference/graphql/index.md#removenegotiablequoteitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removenegotiablequoteitems) ## Example usage 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 e4e3728c3..596424593 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md @@ -35,7 +35,7 @@ The `requestNegotiableQuote` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestnegotiablequote) -* [On-Premises/Cloud](/reference/graphql/index.md#requestnegotiablequote) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestnegotiablequote) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md index f8217d9ee..ebf0d6b70 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md @@ -27,7 +27,7 @@ The `sendNegotiableQuoteForReview` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#sendnegotiablequoteforreview) -* [On-Premises/Cloud](/reference/graphql/index.md#sendnegotiablequoteforreview) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#sendnegotiablequoteforreview) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md index 8b701b0a8..05936db4b 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md @@ -31,7 +31,7 @@ The `setNegotiableQuoteBillingAddress` reference provides detailed information a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequotebillingaddress) -* [On-Premises/Cloud](/reference/graphql/index.md#setnegotiablequotebillingaddress) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequotebillingaddress) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md index a4cac62bc..739a84f17 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md @@ -51,7 +51,7 @@ The `setNegotiableQuotePaymentMethod` reference provides detailed information ab - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequotepaymentmethod) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#setnegotiablequotepaymentmethod) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequotepaymentmethod) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md index f82072a58..0617d4460 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md @@ -31,7 +31,7 @@ The `setNegotiableQuoteShippingAddress` reference provides detailed information * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequoteshippingaddress) -* [On-Premises/Cloud](/reference/graphql/index.md#setnegotiablequoteshippingaddress) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequoteshippingaddress) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md index fe1a4177c..eff400618 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md @@ -39,7 +39,7 @@ The `setNegotiableQuoteShippingMethods` reference provides detailed information * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequoteshippingmethods) -* [On-Premises/Cloud](/reference/graphql/index.md#setnegotiablequoteshippingmethods) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequoteshippingmethods) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md index bd8068fd8..fa73672fe 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md @@ -31,7 +31,7 @@ The `updateNegotiableQuoteQuantities` reference provides detailed information ab * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatenegotiablequotequantities) -* [On-Premises/Cloud](/reference/graphql/index.md#updatenegotiablequotequantities) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatenegotiablequotequantities) ## Example usage 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 aec64f497..6f5b8a057 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md @@ -25,7 +25,7 @@ The `negotiableQuote` reference provides detailed information about the types an * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequote) -* [On-Premises/Cloud](/reference/graphql/index.md#negotiablequote) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequote) ## Example usage 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 2ab031fa5..6169e440d 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quotes.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quotes.md @@ -31,7 +31,7 @@ The `negotiableQuotes` reference provides detailed information about the types a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequotes) -* [On-Premises/Cloud](/reference/graphql/index.md#negotiablequotes) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequotes) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md b/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md index 099e23908..d1b1e8bd8 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/templates.md @@ -32,7 +32,7 @@ The `negotiableQuoteTemplates` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequotetemplates) -* [On-Premises/Cloud](/reference/graphql/index.md#negotiablequotetemplates) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequotetemplates) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md b/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md index a1783801d..0bf1c3274 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md @@ -19,7 +19,7 @@ The `CloseNegotiableQuoteError` union provides details about failed attempts to * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#closenegotiablequoteerror) -* [On-Premises/Cloud](/reference/graphql/index.md#closenegotiablequoteerror) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#closenegotiablequoteerror) **Possible types:** @@ -37,7 +37,7 @@ The `CloseNegotiableQuoteOperationResult` union provides details about the resul * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#closenegotiablequoteoperationresult) -* [On-Premises/Cloud](/reference/graphql/index.md#closenegotiablequoteoperationresult) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#closenegotiablequoteoperationresult) **Possible types:** @@ -54,7 +54,7 @@ The `CompanyStructureEntity` union provides details about a node in a company st * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#companystructureentity) -* [On-Premises/Cloud](/reference/graphql/index.md#companystructureentity) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#companystructureentity) **Possible types:** @@ -71,7 +71,7 @@ The `DeleteNegotiableQuoteError` union provides details about failed attempts to * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletenegotiablequoteerror) -* [On-Premises/Cloud](/reference/graphql/index.md#deletenegotiablequoteerror) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletenegotiablequoteerror) **Possible types:** @@ -89,7 +89,7 @@ The `DeleteNegotiableQuoteOperationResult` union provides details about the resu * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletenegotiablequoteoperationresult) -* [On-Premises/Cloud](/reference/graphql/index.md#deletenegotiablequoteoperationresult) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletenegotiablequoteoperationresult) **Possible types:** diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/index.md b/src/pages/graphql/schema/b2b/purchase-order-rule/index.md index 1520f4bf7..9f2fd89bb 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/index.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/index.md @@ -84,7 +84,7 @@ The following example returns the list of purchase order approval rules. ## Get approval rule details -The `purchase_order_approval_rule` query returns information about the specified approval rule. To retrieve details about the amount or quantity required to trigger an approval rule, you must specify the implementations of the [`PurchaseOrderApprovalRuleConditionInterface`](/reference/graphql/index.md#purchaseorderapprovalruleconditioninterface). +The `purchase_order_approval_rule` query returns information about the specified approval rule. To retrieve details about the amount or quantity required to trigger an approval rule, you must specify the implementations of the [`PurchaseOrderApprovalRuleConditionInterface`](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditioninterface). The following example returns information about the purchase order approval rule. diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md b/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md index 3e17d376f..b5bf04962 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md @@ -13,7 +13,7 @@ keywords: * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#purchaseorderapprovalruleconditioninterface) -* [On-Premises/Cloud](/reference/graphql/index.md#purchaseorderapprovalruleconditioninterface) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditioninterface) It has the following implementations: @@ -21,13 +21,13 @@ It has the following implementations: * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#purchaseorderapprovalruleconditionamount) - * [On-Premises/Cloud](/reference/graphql/index.md#purchaseorderapprovalruleconditionamount) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditionamount) * `PurchaseOrderApprovalRuleConditionQuantity` * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#purchaseorderapprovalruleconditionquantity) - * [On-Premises/Cloud](/reference/graphql/index.md#purchaseorderapprovalruleconditionquantity) + * [On-Premises/Cloud](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditionquantity) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md index 86cdab449..305dbfcbf 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md @@ -41,7 +41,7 @@ The `createPurchaseOrderApprovalRule` reference provides detailed information ab * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createpurchaseorderapprovalrule) -* [On-Premises/Cloud](/reference/graphql/index.md#createpurchaseorderapprovalrule) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createpurchaseorderapprovalrule) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md index a5431fe71..2e12b8b3b 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md @@ -33,7 +33,7 @@ The `deletePurchaseOrderApprovalRule` reference provides detailed information ab * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletepurchaseorderapprovalrule) -* [On-Premises/Cloud](/reference/graphql/index.md#deletepurchaseorderapprovalrule) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletepurchaseorderapprovalrule) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md index 470b8f357..1ede123de 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md @@ -33,7 +33,7 @@ The `updatePurchaseOrderApprovalRule` reference provides detailed information ab * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatepurchaseorderapprovalrule) -* [On-Premises/Cloud](/reference/graphql/index.md#updatepurchaseorderapprovalrule) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatepurchaseorderapprovalrule) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md index ef418ba9e..6fc7d5f6a 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md @@ -31,7 +31,7 @@ The `validatePurchaseOrders` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#validatepurchaseorders) -* [On-Premises/Cloud](/reference/graphql/index.md#validatepurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#validatepurchaseorders) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md index 620b8d37f..8656de757 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md @@ -29,7 +29,7 @@ The `addPurchaseOrderComment` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addpurchaseordercomment) -* [On-Premises/Cloud](/reference/graphql/index.md#addpurchaseordercomment) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addpurchaseordercomment) ## Example usage 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 ce2ddfc58..e812fc0b2 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 @@ -29,7 +29,7 @@ The `addPurchaseOrderItemsToCart` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addpurchaseorderitemstocart) -* [On-Premises/Cloud](/reference/graphql/index.md#addpurchaseorderitemstocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addpurchaseorderitemstocart) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md index ec10fd8c2..744a537f2 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md @@ -29,7 +29,7 @@ The `approvePurchaseOrders` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#approvepurchaseorders) -* [On-Premises/Cloud](/reference/graphql/index.md#approvepurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#approvepurchaseorders) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md index 432d11165..7162fb1bc 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md @@ -29,7 +29,7 @@ The `cancelPurchaseOrders` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cancelpurchaseorders) -* [On-Premises/Cloud](/reference/graphql/index.md#cancelpurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#cancelpurchaseorders) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md index ddd38d132..f43ff9fdd 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md @@ -33,7 +33,7 @@ The `placeOrderForPurchaseOrder` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placeorderforpurchaseorder) -* [On-Premises/Cloud](/reference/graphql/index.md#placeorderforpurchaseorder) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#placeorderforpurchaseorder) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md index 20e590c63..3de6b54bd 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md @@ -33,7 +33,7 @@ The `placePurchaseOrder` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placepurchaseorder) -* [On-Premises/Cloud](/reference/graphql/index.md#placepurchaseorder) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#placepurchaseorder) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md index 0e62e7955..9bb091ace 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md @@ -29,7 +29,7 @@ The `rejectPurchaseOrders` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#rejectpurchaseorders) -* [On-Premises/Cloud](/reference/graphql/index.md#rejectpurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#rejectpurchaseorders) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md b/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md index 7446f4254..f86d338ba 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md +++ b/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md @@ -9,14 +9,14 @@ keywords: # RequisitionListItemInterface attributes and implementations -[`RequisitionListItemInterface`](/reference/graphql/index.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: +[`RequisitionListItemInterface`](/reference/graphql/latest/index.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: -* [`BundleRequisitionListItem`](/reference/graphql/index.md#bundlerequisitionlistitem) -* [`ConfigurableRequisitionListItem`](/reference/graphql/index.md#configurablerequisitionlistitem) -* [`DownloadableRequisitionListItem`](/reference/graphql/index.md#downloadablerequisitionlistitem) -* [`GiftCardRequisitionListItem`](/reference/graphql/index.md#giftcardrequisitionlistitem) -* [`SimpleRequisitionListItem`](/reference/graphql/index.md#simplerequisitionlistitem) -* [`VirtualRequisitionListItem`](/reference/graphql/index.md#virtualrequisitionlistitem) +* [`BundleRequisitionListItem`](/reference/graphql/latest/index.md#bundlerequisitionlistitem) +* [`ConfigurableRequisitionListItem`](/reference/graphql/latest/index.md#configurablerequisitionlistitem) +* [`DownloadableRequisitionListItem`](/reference/graphql/latest/index.md#downloadablerequisitionlistitem) +* [`GiftCardRequisitionListItem`](/reference/graphql/latest/index.md#giftcardrequisitionlistitem) +* [`SimpleRequisitionListItem`](/reference/graphql/latest/index.md#simplerequisitionlistitem) +* [`VirtualRequisitionListItem`](/reference/graphql/latest/index.md#virtualrequisitionlistitem) diff --git a/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md b/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md index 7446f4254..f86d338ba 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md +++ b/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md @@ -9,14 +9,14 @@ keywords: # RequisitionListItemInterface attributes and implementations -[`RequisitionListItemInterface`](/reference/graphql/index.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: +[`RequisitionListItemInterface`](/reference/graphql/latest/index.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: -* [`BundleRequisitionListItem`](/reference/graphql/index.md#bundlerequisitionlistitem) -* [`ConfigurableRequisitionListItem`](/reference/graphql/index.md#configurablerequisitionlistitem) -* [`DownloadableRequisitionListItem`](/reference/graphql/index.md#downloadablerequisitionlistitem) -* [`GiftCardRequisitionListItem`](/reference/graphql/index.md#giftcardrequisitionlistitem) -* [`SimpleRequisitionListItem`](/reference/graphql/index.md#simplerequisitionlistitem) -* [`VirtualRequisitionListItem`](/reference/graphql/index.md#virtualrequisitionlistitem) +* [`BundleRequisitionListItem`](/reference/graphql/latest/index.md#bundlerequisitionlistitem) +* [`ConfigurableRequisitionListItem`](/reference/graphql/latest/index.md#configurablerequisitionlistitem) +* [`DownloadableRequisitionListItem`](/reference/graphql/latest/index.md#downloadablerequisitionlistitem) +* [`GiftCardRequisitionListItem`](/reference/graphql/latest/index.md#giftcardrequisitionlistitem) +* [`SimpleRequisitionListItem`](/reference/graphql/latest/index.md#simplerequisitionlistitem) +* [`VirtualRequisitionListItem`](/reference/graphql/latest/index.md#virtualrequisitionlistitem) diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md index 301c7d8d8..8992815a2 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md @@ -36,7 +36,7 @@ The `addRequisitionListItemsToCart` reference provides detailed information abou * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addrequisitionlistitemstocart) -* [On-Premises/Cloud](/reference/graphql/index.md#addrequisitionlistitemstocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addrequisitionlistitemstocart) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md index 8000a103e..b352572df 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md @@ -36,7 +36,7 @@ The `addProductsToRequisitionList` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstorequisitionlist) -* [On-Premises/Cloud](/reference/graphql/index.md#addproductstorequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstorequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md index e140c090b..8418ed8ae 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md @@ -35,7 +35,7 @@ The `clearCustomerCart` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#clearcustomercart) -* [On-Premises/Cloud](/reference/graphql/index.md#clearcustomercart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#clearcustomercart) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md index 3e52ee246..1111994b9 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md @@ -37,7 +37,7 @@ The `copyItemsBetweenRequisitionLists` reference provides detailed information a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#copyitemsbetweenrequisitionlists) -* [On-Premises/Cloud](/reference/graphql/index.md#copyitemsbetweenrequisitionlists) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#copyitemsbetweenrequisitionlists) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md index fb7f33ee5..1fae00ebf 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md @@ -36,7 +36,7 @@ The `createRequisitionList` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createrequisitionlist) -* [On-Premises/Cloud](/reference/graphql/index.md#createrequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createrequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md index 7e7af35b0..3ec46097e 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md @@ -36,7 +36,7 @@ The `deleteRequisitionListItems` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deleterequisitionlistitems) -* [On-Premises/Cloud](/reference/graphql/index.md#deleterequisitionlistitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deleterequisitionlistitems) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md index 545bf2a86..a1256c28a 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md @@ -35,7 +35,7 @@ The `deleteRequisitionList` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deleterequisitionlist) -* [On-Premises/Cloud](/reference/graphql/index.md#deleterequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deleterequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md index 942fcc6d8..00e9ea23e 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md @@ -37,7 +37,7 @@ The `moveItemsBetweenRequisitionLists` reference provides detailed information a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#moveitemsbetweenrequisitionlists) -* [On-Premises/Cloud](/reference/graphql/index.md#moveitemsbetweenrequisitionlists) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#moveitemsbetweenrequisitionlists) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md index 6e2249f89..905375497 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md @@ -36,7 +36,7 @@ The `updateRequisitionListItems` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updaterequisitionlistitems) -* [On-Premises/Cloud](/reference/graphql/index.md#updaterequisitionlistitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updaterequisitionlistitems) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md index 259764c7a..734dc367f 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md @@ -37,7 +37,7 @@ The `updateRequisitionList` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updaterequisitionlist) -* [On-Premises/Cloud](/reference/graphql/index.md#updaterequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updaterequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/cart/interfaces/index.md b/src/pages/graphql/schema/cart/interfaces/index.md index 390969dea..3c7958a5c 100644 --- a/src/pages/graphql/schema/cart/interfaces/index.md +++ b/src/pages/graphql/schema/cart/interfaces/index.md @@ -5,14 +5,14 @@ description: The CartItemInterface has the following implementations: # CartItemInterface attributes and implementations -The [`CartItemInterface`](/reference/graphql/index.md#cartiteminterface) has the following implementations: +The [`CartItemInterface`](/reference/graphql/latest/index.md#cartiteminterface) has the following implementations: -* [BundleCartItem](/reference/graphql/index.md#bundlecartitem) -* [ConfigurableCartItem](/reference/graphql/index.md#configurablecartitem) -* [DownloadableCartItem](/reference/graphql/index.md#downloadablecartitem) -* [GiftCardCartItem](/reference/graphql/index.md#giftcardcartitem) -* [SimpleCartItem](/reference/graphql/index.md#simplecartitem) -* [VirtualCartItem](/reference/graphql/index.md#virtualcartitem) +* [BundleCartItem](/reference/graphql/latest/index.md#bundlecartitem) +* [ConfigurableCartItem](/reference/graphql/latest/index.md#configurablecartitem) +* [DownloadableCartItem](/reference/graphql/latest/index.md#downloadablecartitem) +* [GiftCardCartItem](/reference/graphql/latest/index.md#giftcardcartitem) +* [SimpleCartItem](/reference/graphql/latest/index.md#simplecartitem) +* [VirtualCartItem](/reference/graphql/latest/index.md#virtualcartitem) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-bundle-products.md b/src/pages/graphql/schema/cart/mutations/add-bundle-products.md index d03c1552a..e2faee9a9 100644 --- a/src/pages/graphql/schema/cart/mutations/add-bundle-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-bundle-products.md @@ -19,7 +19,7 @@ Use the `addBundleProductsToCart` mutation to add bundle products to a specific ## Reference -The [`addBundleProductsToCart`](/reference/graphql/index.md#addbundleproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addBundleProductsToCart`](/reference/graphql/latest/index.md#addbundleproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-configurable-products.md b/src/pages/graphql/schema/cart/mutations/add-configurable-products.md index 94c28dfd0..47a446a83 100644 --- a/src/pages/graphql/schema/cart/mutations/add-configurable-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-configurable-products.md @@ -20,7 +20,7 @@ Use the `addConfigurableProductsToCart` mutation to add configurable products to ## Reference -The [`addConfigurableProductsToCart`](/reference/graphql/index.md#addconfigurableproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addConfigurableProductsToCart`](/reference/graphql/latest/index.md#addconfigurableproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md b/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md index 7a04e0b17..e0f587a99 100644 --- a/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md @@ -27,7 +27,7 @@ mutation: { ## Reference -The [`addDownloadableProductsToCart`](/reference/graphql/index.md#adddownloadableproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addDownloadableProductsToCart`](/reference/graphql/latest/index.md#adddownloadableproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-products.md b/src/pages/graphql/schema/cart/mutations/add-products.md index 7dfd6d251..b7556d83f 100644 --- a/src/pages/graphql/schema/cart/mutations/add-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-products.md @@ -52,7 +52,7 @@ The `addProductsToCart` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstocart) -* [On-Premises/Cloud](/reference/graphql/index.md#addproductstocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-simple-products.md b/src/pages/graphql/schema/cart/mutations/add-simple-products.md index 07e0870c8..518525231 100644 --- a/src/pages/graphql/schema/cart/mutations/add-simple-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-simple-products.md @@ -24,7 +24,7 @@ To add a simple or grouped product to a cart, you must provide the cart ID, the ## Reference -The [`addSimpleProductsToCart`](/reference/graphql/index.md#addsimpleproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addSimpleProductsToCart`](/reference/graphql/latest/index.md#addsimpleproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-virtual-products.md b/src/pages/graphql/schema/cart/mutations/add-virtual-products.md index cce887276..679643d45 100644 --- a/src/pages/graphql/schema/cart/mutations/add-virtual-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-virtual-products.md @@ -22,7 +22,7 @@ The `addVirtualProductsToCart` mutation allows you to add multiple virtual produ ## Reference -The [`addVirtualProductsToCart`](/reference/graphql/index.md#addvirtualproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addVirtualProductsToCart`](/reference/graphql/latest/index.md#addvirtualproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-coupon.md b/src/pages/graphql/schema/cart/mutations/apply-coupon.md index 10d3c0107..682738cab 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-coupon.md +++ b/src/pages/graphql/schema/cart/mutations/apply-coupon.md @@ -17,7 +17,7 @@ The `applyCouponToCart` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applycoupontocart) -* [On-Premises/Cloud](/reference/graphql/index.md#applycoupontocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#applycoupontocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-coupons.md b/src/pages/graphql/schema/cart/mutations/apply-coupons.md index 3c25366b2..aca2116a9 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-coupons.md +++ b/src/pages/graphql/schema/cart/mutations/apply-coupons.md @@ -21,7 +21,7 @@ The `applyCouponsToCart` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applycouponstocart) -* [On-Premises/Cloud](/reference/graphql/index.md#applycouponstocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#applycouponstocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-giftcard.md b/src/pages/graphql/schema/cart/mutations/apply-giftcard.md index bdacd7793..c1ecd889f 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-giftcard.md +++ b/src/pages/graphql/schema/cart/mutations/apply-giftcard.md @@ -19,7 +19,7 @@ The `applyGiftCardToCart` reference provides detailed information about the type * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applygiftcardtocart) -* [On-Premises/Cloud](/reference/graphql/index.md#applygiftcardtocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#applygiftcardtocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-reward-points.md b/src/pages/graphql/schema/cart/mutations/apply-reward-points.md index 0d3ba72f9..c9184c495 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-reward-points.md +++ b/src/pages/graphql/schema/cart/mutations/apply-reward-points.md @@ -21,7 +21,7 @@ The `applyRewardPointsToCart` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applyrewardpointstocart) -* [On-Premises/Cloud](/reference/graphql/index.md#applyrewardpointstocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#applyrewardpointstocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-store-credit.md b/src/pages/graphql/schema/cart/mutations/apply-store-credit.md index 273b41b03..c554cce2d 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-store-credit.md +++ b/src/pages/graphql/schema/cart/mutations/apply-store-credit.md @@ -27,7 +27,7 @@ The `applyStoreCreditToCart` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applystorecredittocart) -* [On-Premises/Cloud](/reference/graphql/index.md#applystorecredittocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#applystorecredittocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md b/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md index 00d41fefd..49e3029bf 100644 --- a/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md +++ b/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md @@ -35,7 +35,7 @@ The `assignCustomerToGuestCart` reference provides detailed information about th * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#assigncustomertoguestcart) -* [On-Premises/Cloud](/reference/graphql/index.md#assigncustomertoguestcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#assigncustomertoguestcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/clear-cart.md b/src/pages/graphql/schema/cart/mutations/clear-cart.md index a9b24e9d4..092982bd4 100644 --- a/src/pages/graphql/schema/cart/mutations/clear-cart.md +++ b/src/pages/graphql/schema/cart/mutations/clear-cart.md @@ -24,7 +24,7 @@ mutation { ## Reference -The [`clearCart`](/reference/graphql/index.md#clearcart) reference provides detailed information about the types and fields defined in this mutation. +The [`clearCart`](/reference/graphql/latest/index.md#clearcart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/create-empty-cart.md b/src/pages/graphql/schema/cart/mutations/create-empty-cart.md index 8869230d0..36db02227 100644 --- a/src/pages/graphql/schema/cart/mutations/create-empty-cart.md +++ b/src/pages/graphql/schema/cart/mutations/create-empty-cart.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`createEmptyCart`](/reference/graphql/index.md#createemptycart) reference provides detailed information about the types and fields defined in this mutation. +The [`createEmptyCart`](/reference/graphql/latest/index.md#createemptycart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/create-guest-cart.md b/src/pages/graphql/schema/cart/mutations/create-guest-cart.md index c5ecb6e03..3282d580f 100644 --- a/src/pages/graphql/schema/cart/mutations/create-guest-cart.md +++ b/src/pages/graphql/schema/cart/mutations/create-guest-cart.md @@ -23,7 +23,7 @@ The `createGuestCart` reference provides detailed information about the types an * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createguestcart) -* [On-Premises/Cloud](/reference/graphql/index.md#createguestcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createguestcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md b/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md index 4a9b846c2..da26666a6 100644 --- a/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md +++ b/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md @@ -24,7 +24,7 @@ The `estimateShippingMethods` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#estimateshippingmethods) -* [On-Premises/Cloud](/reference/graphql/index.md#estimateshippingmethods) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#estimateshippingmethods) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/estimate-totals.md b/src/pages/graphql/schema/cart/mutations/estimate-totals.md index 52f89e974..e43ca7492 100644 --- a/src/pages/graphql/schema/cart/mutations/estimate-totals.md +++ b/src/pages/graphql/schema/cart/mutations/estimate-totals.md @@ -24,7 +24,7 @@ The `estimateTotals` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#estimatetotals) -* [On-Premises/Cloud](/reference/graphql/index.md#estimatetotals) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#estimatetotals) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/merge.md b/src/pages/graphql/schema/cart/mutations/merge.md index d10117daa..22258ce1c 100644 --- a/src/pages/graphql/schema/cart/mutations/merge.md +++ b/src/pages/graphql/schema/cart/mutations/merge.md @@ -35,7 +35,7 @@ The `mergeCarts` reference provides detailed information about the types and fie * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#mergecarts) -* [On-Premises/Cloud](/reference/graphql/index.md#mergecarts) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#mergecarts) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/place-order.md b/src/pages/graphql/schema/cart/mutations/place-order.md index d07c7840a..3cfd29fd6 100644 --- a/src/pages/graphql/schema/cart/mutations/place-order.md +++ b/src/pages/graphql/schema/cart/mutations/place-order.md @@ -43,7 +43,7 @@ The `placeOrder` reference provides detailed information about the types and fie - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placeorder) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#placeorder) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#placeorder) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md b/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md index f7a61c8a6..0b5854a5f 100644 --- a/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md +++ b/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md @@ -31,7 +31,7 @@ The `redeemGiftCardBalanceAsStoreCredit` reference provides detailed information * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#redeemgiftcardbalanceasstorecredit) -* [On-Premises/Cloud](/reference/graphql/index.md#redeemgiftcardbalanceasstorecredit) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#redeemgiftcardbalanceasstorecredit) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-coupon.md b/src/pages/graphql/schema/cart/mutations/remove-coupon.md index 498085080..96974dd92 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-coupon.md +++ b/src/pages/graphql/schema/cart/mutations/remove-coupon.md @@ -17,7 +17,7 @@ The `removeCouponFromCart` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removecouponfromcart) -* [On-Premises/Cloud](/reference/graphql/index.md#removecouponfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removecouponfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-coupons.md b/src/pages/graphql/schema/cart/mutations/remove-coupons.md index da3e6e2e2..b6ac6bd92 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-coupons.md +++ b/src/pages/graphql/schema/cart/mutations/remove-coupons.md @@ -19,7 +19,7 @@ The `removeCouponsFromCart` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removecouponsfromcart) -* [On-Premises/Cloud](/reference/graphql/index.md#removecouponsfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removecouponsfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-giftcard.md b/src/pages/graphql/schema/cart/mutations/remove-giftcard.md index 80acd8029..955182fb4 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-giftcard.md +++ b/src/pages/graphql/schema/cart/mutations/remove-giftcard.md @@ -19,7 +19,7 @@ The `removeGiftCardFromCart` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftcardfromcart) -* [On-Premises/Cloud](/reference/graphql/index.md#removegiftcardfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftcardfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-item.md b/src/pages/graphql/schema/cart/mutations/remove-item.md index 179dc9b5a..d925d37a0 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-item.md +++ b/src/pages/graphql/schema/cart/mutations/remove-item.md @@ -17,7 +17,7 @@ The `removeItemFromCart` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removeitemfromcart) -* [On-Premises/Cloud](/reference/graphql/index.md#removeitemfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removeitemfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-reward-points.md b/src/pages/graphql/schema/cart/mutations/remove-reward-points.md index 99ef2df3e..25fd4cfbb 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-reward-points.md +++ b/src/pages/graphql/schema/cart/mutations/remove-reward-points.md @@ -19,7 +19,7 @@ The `removeRewardPointsFromCart` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removerewardpointsfromcart) -* [On-Premises/Cloud](/reference/graphql/index.md#removerewardpointsfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removerewardpointsfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-store-credit.md b/src/pages/graphql/schema/cart/mutations/remove-store-credit.md index 600158cba..a018564d5 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-store-credit.md +++ b/src/pages/graphql/schema/cart/mutations/remove-store-credit.md @@ -21,7 +21,7 @@ The `removeStoreCreditFromCart` reference provides detailed information about th * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removestorecreditfromcart) -* [On-Premises/Cloud](/reference/graphql/index.md#removestorecreditfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removestorecreditfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-billing-address.md b/src/pages/graphql/schema/cart/mutations/set-billing-address.md index 9ab585328..c153ebeeb 100644 --- a/src/pages/graphql/schema/cart/mutations/set-billing-address.md +++ b/src/pages/graphql/schema/cart/mutations/set-billing-address.md @@ -17,7 +17,7 @@ The `setBillingAddressOnCart` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setbillingaddressoncart) -* [On-Premises/Cloud](/reference/graphql/index.md#setbillingaddressoncart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setbillingaddressoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-gift-options.md b/src/pages/graphql/schema/cart/mutations/set-gift-options.md index 78d345959..9764e68a8 100644 --- a/src/pages/graphql/schema/cart/mutations/set-gift-options.md +++ b/src/pages/graphql/schema/cart/mutations/set-gift-options.md @@ -45,7 +45,7 @@ The `setGiftOptionsOnCart` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setgiftoptionsoncart) -* [On-Premises/Cloud](/reference/graphql/index.md#setgiftoptionsoncart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setgiftoptionsoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-guest-email.md b/src/pages/graphql/schema/cart/mutations/set-guest-email.md index ca183f633..b66c380ee 100644 --- a/src/pages/graphql/schema/cart/mutations/set-guest-email.md +++ b/src/pages/graphql/schema/cart/mutations/set-guest-email.md @@ -19,7 +19,7 @@ The `setGuestEmailOnCart` reference provides detailed information about the type * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setguestemailoncart) -* [On-Premises/Cloud](/reference/graphql/index.md#setguestemailoncart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setguestemailoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-payment-method.md b/src/pages/graphql/schema/cart/mutations/set-payment-method.md index 6aa7eaf04..7bc877452 100644 --- a/src/pages/graphql/schema/cart/mutations/set-payment-method.md +++ b/src/pages/graphql/schema/cart/mutations/set-payment-method.md @@ -46,7 +46,7 @@ The `setPaymentMethodOnCart` reference provides detailed information about the t - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setpaymentmethodoncart) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#setpaymentmethodoncart) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#setpaymentmethodoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md b/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md index 8f0b834f0..e8fc954be 100644 --- a/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md +++ b/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md @@ -42,7 +42,7 @@ mutation { ## Reference -The [`setPaymentMethodAndPlaceOrder`](/reference/graphql/index.md#setpaymentmethodandplaceorder) reference provides detailed information about the types and fields defined in this mutation. +The [`setPaymentMethodAndPlaceOrder`](/reference/graphql/latest/index.md#setpaymentmethodandplaceorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-shipping-address.md b/src/pages/graphql/schema/cart/mutations/set-shipping-address.md index 3ca947c20..3933ef403 100644 --- a/src/pages/graphql/schema/cart/mutations/set-shipping-address.md +++ b/src/pages/graphql/schema/cart/mutations/set-shipping-address.md @@ -20,7 +20,7 @@ The `setShippingAddressesOnCart` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setshippingaddressesoncart) -* [On-Premises/Cloud](/reference/graphql/index.md#setshippingaddressesoncart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setshippingaddressesoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-shipping-method.md b/src/pages/graphql/schema/cart/mutations/set-shipping-method.md index baff88670..bc0913af3 100644 --- a/src/pages/graphql/schema/cart/mutations/set-shipping-method.md +++ b/src/pages/graphql/schema/cart/mutations/set-shipping-method.md @@ -31,7 +31,7 @@ The `setShippingMethodsOnCart` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setshippingmethodsoncart) -* [On-Premises/Cloud](/reference/graphql/index.md#setshippingmethodsoncart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#setshippingmethodsoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/update-items.md b/src/pages/graphql/schema/cart/mutations/update-items.md index 3392e8fc0..17618fb11 100644 --- a/src/pages/graphql/schema/cart/mutations/update-items.md +++ b/src/pages/graphql/schema/cart/mutations/update-items.md @@ -21,7 +21,7 @@ The `updateCartItems` reference provides detailed information about the types an * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecartitems) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecartitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecartitems) ## Example usage diff --git a/src/pages/graphql/schema/cart/queries/cart.md b/src/pages/graphql/schema/cart/queries/cart.md index a62962a84..abba3dcec 100644 --- a/src/pages/graphql/schema/cart/queries/cart.md +++ b/src/pages/graphql/schema/cart/queries/cart.md @@ -23,7 +23,7 @@ The `cart` reference provides detailed information about the types and fields de * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cart) -* [On-Premises/Cloud](/reference/graphql/index.md#cart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#cart) ## Sample queries @@ -612,7 +612,7 @@ The following query shows how to retrieve fixed product tax (FPT) information fo Note that fixed product tax information appears under `cart.items.prices.fixed_product_taxes` rather than in the `applied_taxes` section. The FPT amount is included in the `subtotal_including_tax` and `grand_total` values. -For more details about cart item prices and FPT fields in the schema, see the [CartItemPrices](/reference/graphql/index.md#cartitemprices) reference. +For more details about cart item prices and FPT fields in the schema, see the [CartItemPrices](/reference/graphql/latest/index.md#cartitemprices) reference. ### Tier price example diff --git a/src/pages/graphql/schema/cart/queries/index.md b/src/pages/graphql/schema/cart/queries/index.md index edc914010..ee2553848 100644 --- a/src/pages/graphql/schema/cart/queries/index.md +++ b/src/pages/graphql/schema/cart/queries/index.md @@ -5,6 +5,6 @@ description: The cart query returns the content of the shopper's cart. Adobe Com # Cart queries -The [`cart`](cart.md) query returns the content of the shopper's cart. Adobe Commerce returns the [`Cart`](/reference/graphql/index.md#cart) object. This object is also returned by numerous mutations, including those that add products to the cart and prepare a cart for checkout. +The [`cart`](cart.md) query returns the content of the shopper's cart. Adobe Commerce returns the [`Cart`](/reference/graphql/latest/index.md#cart) object. This object is also returned by numerous mutations, including those that add products to the cart and prepare a cart for checkout. When Inventory Management is installed and configured, you can use the [`pickupLocations`](pickup-locations.md) query to help a shopper determine whether their order can be picked up at a physical location. This query is most useful when the shopper has selected one or more items for purchase. diff --git a/src/pages/graphql/schema/cart/queries/pickup-locations.md b/src/pages/graphql/schema/cart/queries/pickup-locations.md index 9f52c6341..fd4acb07f 100644 --- a/src/pages/graphql/schema/cart/queries/pickup-locations.md +++ b/src/pages/graphql/schema/cart/queries/pickup-locations.md @@ -39,7 +39,7 @@ The `pickupLocations` reference provides detailed information about the types an * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#pickuplocations) -* [On-Premises/Cloud](/reference/graphql/index.md#pickuplocations) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#pickuplocations) ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md b/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md index ec600ad77..b050a1883 100644 --- a/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md +++ b/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md @@ -20,7 +20,7 @@ mutation { ## Reference -The [`createBraintreeClientToken`](/reference/graphql/index.md#createbraintreeclienttoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createBraintreeClientToken`](/reference/graphql/latest/index.md#createbraintreeclienttoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md b/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md index 387649113..8887dae7d 100644 --- a/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md +++ b/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md @@ -30,7 +30,7 @@ mutation { ## Reference -The [`createPayflowProToken`](/reference/graphql/index.md#createpayflowprotoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createPayflowProToken`](/reference/graphql/latest/index.md#createpayflowprotoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md b/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md index 373aa6a88..06841ab77 100644 --- a/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md +++ b/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md @@ -32,7 +32,7 @@ mutation { ## Reference -The [`createPaypalExpressToken`](/reference/graphql/index.md#createpaypalexpresstoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createPaypalExpressToken`](/reference/graphql/latest/index.md#createpaypalexpresstoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md b/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md index 1c7f28109..523abe0b0 100644 --- a/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md +++ b/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md @@ -29,7 +29,7 @@ The `deletePaymentToken` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletepaymenttoken) -* [On-Premises/Cloud](/reference/graphql/index.md#deletepaymenttoken) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletepaymenttoken) ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md b/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md index 4726eced6..0c644f830 100644 --- a/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md +++ b/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md @@ -31,7 +31,7 @@ See [PayPal Payflow Pro payment method](../../../payment-methods/payflow-pro.md) ## Reference -The [`handlePayflowProResponse`](/reference/graphql/index.md#handlepayflowproresponse) reference provides detailed information about the types and fields defined in this mutation. +The [`handlePayflowProResponse`](/reference/graphql/latest/index.md#handlepayflowproresponse) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/queries/agreements.md b/src/pages/graphql/schema/checkout/queries/agreements.md index 4e9f416a1..89c1dadd6 100644 --- a/src/pages/graphql/schema/checkout/queries/agreements.md +++ b/src/pages/graphql/schema/checkout/queries/agreements.md @@ -19,7 +19,7 @@ The `checkoutAgreements` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#checkoutagreements) -* [On-Premises/Cloud](/reference/graphql/index.md#checkoutagreements) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#checkoutagreements) ## Example usage diff --git a/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md b/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md index fc2ece6e3..add900677 100644 --- a/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md +++ b/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md @@ -23,7 +23,7 @@ The `customerPaymentTokens` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customerpaymenttokens) -* [On-Premises/Cloud](/reference/graphql/index.md#customerpaymenttokens) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#customerpaymenttokens) ## Example usage diff --git a/src/pages/graphql/schema/checkout/queries/get-hosted-pro-url.md b/src/pages/graphql/schema/checkout/queries/get-hosted-pro-url.md index 2b4c5e35a..6102e9936 100644 --- a/src/pages/graphql/schema/checkout/queries/get-hosted-pro-url.md +++ b/src/pages/graphql/schema/checkout/queries/get-hosted-pro-url.md @@ -16,7 +16,7 @@ The `getHostedProUrl` query is required to complete a transaction when the [PayP ## Reference -The [`getHostedProUrl`](/reference/graphql/index.md#gethostedprourl) reference provides detailed information about the types and fields defined in this query. +The [`getHostedProUrl`](/reference/graphql/latest/index.md#gethostedprourl) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/checkout/queries/get-payflow-link-token.md b/src/pages/graphql/schema/checkout/queries/get-payflow-link-token.md index 27337fb27..2d36a00d3 100644 --- a/src/pages/graphql/schema/checkout/queries/get-payflow-link-token.md +++ b/src/pages/graphql/schema/checkout/queries/get-payflow-link-token.md @@ -18,7 +18,7 @@ See [PayPal Payflow Link payment method](../../../payment-methods/payflow-link.m ## Reference -The [`getPayflowLinkToken`](/reference/graphql/index.md#getpayflowlinktoken) reference provides detailed information about the types and fields defined in this query. +The [`getPayflowLinkToken`](/reference/graphql/latest/index.md#getpayflowlinktoken) reference provides detailed information about the types and fields defined in this query. ## Example diff --git a/src/pages/graphql/schema/customer/index.md b/src/pages/graphql/schema/customer/index.md index 78f2d86e3..eeacc36cf 100644 --- a/src/pages/graphql/schema/customer/index.md +++ b/src/pages/graphql/schema/customer/index.md @@ -9,7 +9,7 @@ A customer is a shopper who has created an account for the store. To return or modify information about a customer, we recommend you use [customer tokens](../../usage/authorization-tokens.md) in the header of your GraphQL calls. However, you also can use [session authentication](/get-started/authentication/gs-authentication-session.md). -B2B for Adobe Commerce adds the following top-level fields to the [`Customer`](/reference/graphql/index.md#customer) object for company administrators and users. +B2B for Adobe Commerce adds the following top-level fields to the [`Customer`](/reference/graphql/latest/index.md#customer) object for company administrators and users. * `job_title` * `requisition_lists` diff --git a/src/pages/graphql/schema/customer/mutations/assign-compare-list.md b/src/pages/graphql/schema/customer/mutations/assign-compare-list.md index 59904df8b..3bb543b1a 100644 --- a/src/pages/graphql/schema/customer/mutations/assign-compare-list.md +++ b/src/pages/graphql/schema/customer/mutations/assign-compare-list.md @@ -27,7 +27,7 @@ The `assignCompareListToCustomer` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#assigncomparelisttocustomer) -* [On-Premises/Cloud](/reference/graphql/index.md#assigncomparelisttocustomer) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#assigncomparelisttocustomer) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/change-password.md b/src/pages/graphql/schema/customer/mutations/change-password.md index f73f9d1ce..81a597375 100644 --- a/src/pages/graphql/schema/customer/mutations/change-password.md +++ b/src/pages/graphql/schema/customer/mutations/change-password.md @@ -19,7 +19,7 @@ The `changeCustomerPassword` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#changecustomerpassword) -* [On-Premises/Cloud](/reference/graphql/index.md#changecustomerpassword) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#changecustomerpassword) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/confirm-email.md b/src/pages/graphql/schema/customer/mutations/confirm-email.md index cb02ba87f..068da19a0 100644 --- a/src/pages/graphql/schema/customer/mutations/confirm-email.md +++ b/src/pages/graphql/schema/customer/mutations/confirm-email.md @@ -17,7 +17,7 @@ The `confirmEmail` reference provides detailed information about the types and f * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#confirmemail) -* [On-Premises/Cloud](/reference/graphql/index.md#confirmemail) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#confirmemail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/create-address.md b/src/pages/graphql/schema/customer/mutations/create-address.md index 00d77e904..39700aecb 100644 --- a/src/pages/graphql/schema/customer/mutations/create-address.md +++ b/src/pages/graphql/schema/customer/mutations/create-address.md @@ -19,7 +19,7 @@ The `createCustomerAddress` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcustomeraddress) -* [On-Premises/Cloud](/reference/graphql/index.md#createcustomeraddress) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcustomeraddress) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/create-v2.md b/src/pages/graphql/schema/customer/mutations/create-v2.md index eb62a5bf4..10af06e7f 100644 --- a/src/pages/graphql/schema/customer/mutations/create-v2.md +++ b/src/pages/graphql/schema/customer/mutations/create-v2.md @@ -23,7 +23,7 @@ The `createCustomerV2` reference provides detailed information about the types a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcustomerv2) -* [On-Premises/Cloud](/reference/graphql/index.md#createcustomerv2) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcustomerv2) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/create.md b/src/pages/graphql/schema/customer/mutations/create.md index a8621b6e3..9412da9b7 100644 --- a/src/pages/graphql/schema/customer/mutations/create.md +++ b/src/pages/graphql/schema/customer/mutations/create.md @@ -24,7 +24,7 @@ To return or modify information about a customer, we recommend you use customer ## Reference -The [`createCustomer`](/reference/graphql/index.md#createcustomer) reference provides detailed information about the types and fields defined in this mutation. +The [`createCustomer`](/reference/graphql/latest/index.md#createcustomer) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/delete-address.md b/src/pages/graphql/schema/customer/mutations/delete-address.md index 4269ffe88..bdb3e3b1d 100644 --- a/src/pages/graphql/schema/customer/mutations/delete-address.md +++ b/src/pages/graphql/schema/customer/mutations/delete-address.md @@ -31,7 +31,7 @@ The `deleteCustomerAddress` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecustomeraddress) -* [On-Premises/Cloud](/reference/graphql/index.md#deletecustomeraddress) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecustomeraddress) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md b/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md index 0dff4f534..889f7e85b 100644 --- a/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md +++ b/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md @@ -21,7 +21,7 @@ The `generateCustomerTokenAsAdmin` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#generatecustomertokenasadmin) -* [On-Premises/Cloud](/reference/graphql/index.md#generatecustomertokenasadmin) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#generatecustomertokenasadmin) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/generate-token.md b/src/pages/graphql/schema/customer/mutations/generate-token.md index eeff3732f..0257a9810 100644 --- a/src/pages/graphql/schema/customer/mutations/generate-token.md +++ b/src/pages/graphql/schema/customer/mutations/generate-token.md @@ -57,7 +57,7 @@ mutation { ## Reference -The [`generateCustomerToken`](/reference/graphql/index.md#generatecustomertoken) reference provides detailed information about the types and fields defined in this mutation. +The [`generateCustomerToken`](/reference/graphql/latest/index.md#generatecustomertoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md b/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md index 42f495b52..a824da194 100644 --- a/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md +++ b/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md @@ -36,7 +36,7 @@ The `requestPasswordResetEmail` reference provides detailed information about th - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestpasswordresetemail) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#requestpasswordresetemail) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#requestpasswordresetemail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md b/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md index f2eda9eb2..b70a9118e 100644 --- a/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md +++ b/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md @@ -19,7 +19,7 @@ The `resendConfirmationEmail` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#resendconfirmationemail) -* [On-Premises/Cloud](/reference/graphql/index.md#resendconfirmationemail) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#resendconfirmationemail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/reset-password.md b/src/pages/graphql/schema/customer/mutations/reset-password.md index dcaa166fc..222e8b324 100644 --- a/src/pages/graphql/schema/customer/mutations/reset-password.md +++ b/src/pages/graphql/schema/customer/mutations/reset-password.md @@ -25,7 +25,7 @@ The `resetPassword` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#resetpassword) -* [On-Premises/Cloud](/reference/graphql/index.md#resetpassword) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#resetpassword) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/revoke-token.md b/src/pages/graphql/schema/customer/mutations/revoke-token.md index 81d284d15..6601af9b4 100644 --- a/src/pages/graphql/schema/customer/mutations/revoke-token.md +++ b/src/pages/graphql/schema/customer/mutations/revoke-token.md @@ -25,7 +25,7 @@ The `revokeCustomerToken` reference provides detailed information about the type * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#revokecustomertoken) -* [On-Premises/Cloud](/reference/graphql/index.md#revokecustomertoken) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#revokecustomertoken) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md b/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md index 857ba8a3c..5b8d4da4c 100644 --- a/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md +++ b/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`sendEmailToFriend`](/reference/graphql/index.md#sendemailtofriend) reference provides detailed information about the types and fields defined in this mutation. +The [`sendEmailToFriend`](/reference/graphql/latest/index.md#sendemailtofriend) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md b/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md index d56dc8644..11d7f461c 100644 --- a/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md +++ b/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md @@ -17,7 +17,7 @@ The `subscribeEmailToNewsletter` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#subscribeemailtonewsletter) -* [On-Premises/Cloud](/reference/graphql/index.md#subscribeemailtonewsletter) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#subscribeemailtonewsletter) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-address.md b/src/pages/graphql/schema/customer/mutations/update-address.md index f3e901c78..987894769 100644 --- a/src/pages/graphql/schema/customer/mutations/update-address.md +++ b/src/pages/graphql/schema/customer/mutations/update-address.md @@ -23,7 +23,7 @@ The `updateCustomerAddress` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomeraddress) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecustomeraddress) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecustomeraddress) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-email.md b/src/pages/graphql/schema/customer/mutations/update-email.md index 776b8405b..fa66f568d 100644 --- a/src/pages/graphql/schema/customer/mutations/update-email.md +++ b/src/pages/graphql/schema/customer/mutations/update-email.md @@ -19,7 +19,7 @@ The `updateCustomerEmail` reference provides detailed information about the type * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomeremail) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecustomeremail) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecustomeremail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-v2.md b/src/pages/graphql/schema/customer/mutations/update-v2.md index 3b10b25eb..289eb9be1 100644 --- a/src/pages/graphql/schema/customer/mutations/update-v2.md +++ b/src/pages/graphql/schema/customer/mutations/update-v2.md @@ -25,7 +25,7 @@ The `updateCustomerV2` reference provides detailed information about the types a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomerv2) -* [On-Premises/Cloud](/reference/graphql/index.md#updatecustomerv2) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecustomerv2) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update.md b/src/pages/graphql/schema/customer/mutations/update.md index ed6a8f434..ce3d600dc 100644 --- a/src/pages/graphql/schema/customer/mutations/update.md +++ b/src/pages/graphql/schema/customer/mutations/update.md @@ -22,7 +22,7 @@ To return or modify information about a customer, we recommend you use customer ## Reference -The [`updateCustomer`](/reference/graphql/index.md#updatecustomer) reference provides detailed information about the types and fields defined in this mutation. +The [`updateCustomer`](/reference/graphql/latest/index.md#updatecustomer) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/cart.md b/src/pages/graphql/schema/customer/queries/cart.md index be338ee00..1148041b0 100644 --- a/src/pages/graphql/schema/customer/queries/cart.md +++ b/src/pages/graphql/schema/customer/queries/cart.md @@ -28,7 +28,7 @@ The `customerCart` reference provides detailed information about the types and f - [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customercart) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/index.md#customercart) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#customercart) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/customer.md b/src/pages/graphql/schema/customer/queries/customer.md index 9446e9335..3289acbd8 100644 --- a/src/pages/graphql/schema/customer/queries/customer.md +++ b/src/pages/graphql/schema/customer/queries/customer.md @@ -19,7 +19,7 @@ The `customer` reference provides detailed information about the types and field * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customer) -* [On-Premises/Cloud](/reference/graphql/index.md#customer) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#customer) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/downloadable-products.md b/src/pages/graphql/schema/customer/queries/downloadable-products.md index ea7b2a065..c3f8fec91 100644 --- a/src/pages/graphql/schema/customer/queries/downloadable-products.md +++ b/src/pages/graphql/schema/customer/queries/downloadable-products.md @@ -16,7 +16,7 @@ Use the `customerDownloadableProducts` query to retrieve the list of purchased d ## Reference -The [`customerDownloadableProducts`](/reference/graphql/index.md#customerdownloadableproducts) reference provides detailed information about the types and fields defined in this query. +The [`customerDownloadableProducts`](/reference/graphql/latest/index.md#customerdownloadableproducts) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/giftcard-account.md b/src/pages/graphql/schema/customer/queries/giftcard-account.md index 45302f0b0..f2c7c1111 100644 --- a/src/pages/graphql/schema/customer/queries/giftcard-account.md +++ b/src/pages/graphql/schema/customer/queries/giftcard-account.md @@ -19,7 +19,7 @@ The `giftCardAccount` reference provides detailed information about the types an * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftcardaccount) -* [On-Premises/Cloud](/reference/graphql/index.md#giftcardaccount) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftcardaccount) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/is-email-available.md b/src/pages/graphql/schema/customer/queries/is-email-available.md index 28054e319..c63f15e5f 100644 --- a/src/pages/graphql/schema/customer/queries/is-email-available.md +++ b/src/pages/graphql/schema/customer/queries/is-email-available.md @@ -19,7 +19,7 @@ The `isEmailAvailable` reference provides detailed information about the types a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#isemailavailable) -* [On-Premises/Cloud](/reference/graphql/index.md#isemailavailable) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#isemailavailable) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/orders.md b/src/pages/graphql/schema/customer/queries/orders.md index 706a1cb42..d7fae077e 100644 --- a/src/pages/graphql/schema/customer/queries/orders.md +++ b/src/pages/graphql/schema/customer/queries/orders.md @@ -22,7 +22,7 @@ We recommend you use customer tokens in the header of your GraphQL calls. Howeve ## Reference -The [`customerOrders`](/reference/graphql/index.md#customerorders) reference provides detailed information about the types and fields defined in this query. +The [`customerOrders`](/reference/graphql/latest/index.md#customerorders) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md b/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md index beeaac6c8..767b53cd6 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md +++ b/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md @@ -30,7 +30,7 @@ The `addGiftRegistryRegistrants` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addgiftregistryregistrants) -* [On-Premises/Cloud](/reference/graphql/index.md#addgiftregistryregistrants) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addgiftregistryregistrants) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/create.md b/src/pages/graphql/schema/gift-registry/mutations/create.md index 060aa12e0..2228d9a34 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/create.md +++ b/src/pages/graphql/schema/gift-registry/mutations/create.md @@ -42,7 +42,7 @@ The `createGiftRegistry` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#creategiftregistry) -* [On-Premises/Cloud](/reference/graphql/index.md#creategiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#creategiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md b/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md index bbfda9858..c0f122cc3 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md +++ b/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md @@ -30,7 +30,7 @@ The `moveCartItemsToGiftRegistry` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#movecartitemstogiftregistry) -* [On-Premises/Cloud](/reference/graphql/index.md#movecartitemstogiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#movecartitemstogiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/remove-items.md b/src/pages/graphql/schema/gift-registry/mutations/remove-items.md index 94f642536..430c7b316 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/remove-items.md +++ b/src/pages/graphql/schema/gift-registry/mutations/remove-items.md @@ -30,7 +30,7 @@ The `removeGiftRegistryItems` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftregistryitems) -* [On-Premises/Cloud](/reference/graphql/index.md#removegiftregistryitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftregistryitems) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md b/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md index 8262e3e02..23426b2df 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md +++ b/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md @@ -30,7 +30,7 @@ The `removeGiftRegistryRegistrants` reference provides detailed information abou * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftregistryregistrants) -* [On-Premises/Cloud](/reference/graphql/index.md#removegiftregistryregistrants) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftregistryregistrants) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/remove.md b/src/pages/graphql/schema/gift-registry/mutations/remove.md index 1e4381ea6..61edad4bb 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/remove.md +++ b/src/pages/graphql/schema/gift-registry/mutations/remove.md @@ -23,7 +23,7 @@ The `removeGiftRegistry` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftregistry) -* [On-Premises/Cloud](/reference/graphql/index.md#removegiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/share.md b/src/pages/graphql/schema/gift-registry/mutations/share.md index ac2f755f6..07a171df2 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/share.md +++ b/src/pages/graphql/schema/gift-registry/mutations/share.md @@ -31,7 +31,7 @@ The `shareGiftRegistry` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#sharegiftregistry) -* [On-Premises/Cloud](/reference/graphql/index.md#sharegiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#sharegiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/update-items.md b/src/pages/graphql/schema/gift-registry/mutations/update-items.md index 1d1723dbe..1c6c6fa26 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/update-items.md +++ b/src/pages/graphql/schema/gift-registry/mutations/update-items.md @@ -30,7 +30,7 @@ The `updateGiftRegistryItems` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updategiftregistryitems) -* [On-Premises/Cloud](/reference/graphql/index.md#updategiftregistryitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updategiftregistryitems) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md b/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md index 9af926c4d..e6fa9edca 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md +++ b/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md @@ -30,7 +30,7 @@ The `updateGiftRegistryRegistrants` reference provides detailed information abou * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updategiftregistryregistrants) -* [On-Premises/Cloud](/reference/graphql/index.md#updategiftregistryregistrants) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updategiftregistryregistrants) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/update.md b/src/pages/graphql/schema/gift-registry/mutations/update.md index 182b93995..41933bfb8 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/update.md +++ b/src/pages/graphql/schema/gift-registry/mutations/update.md @@ -32,7 +32,7 @@ The `updateGiftRegistry` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updategiftregistry) -* [On-Premises/Cloud](/reference/graphql/index.md#updategiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updategiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/email-search.md b/src/pages/graphql/schema/gift-registry/queries/email-search.md index 4918e3738..ad4c8848b 100644 --- a/src/pages/graphql/schema/gift-registry/queries/email-search.md +++ b/src/pages/graphql/schema/gift-registry/queries/email-search.md @@ -21,7 +21,7 @@ The `giftRegistryEmailSearch` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistryemailsearch) -* [On-Premises/Cloud](/reference/graphql/index.md#giftregistryemailsearch) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistryemailsearch) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/gift-registry.md b/src/pages/graphql/schema/gift-registry/queries/gift-registry.md index 817b0a5bd..a69759d96 100644 --- a/src/pages/graphql/schema/gift-registry/queries/gift-registry.md +++ b/src/pages/graphql/schema/gift-registry/queries/gift-registry.md @@ -23,7 +23,7 @@ The `giftRegistry` reference provides detailed information about the types and f * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistry) -* [On-Premises/Cloud](/reference/graphql/index.md#giftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/id-search.md b/src/pages/graphql/schema/gift-registry/queries/id-search.md index b9aa2e7b1..b938a48f2 100644 --- a/src/pages/graphql/schema/gift-registry/queries/id-search.md +++ b/src/pages/graphql/schema/gift-registry/queries/id-search.md @@ -21,7 +21,7 @@ The `giftRegistryIdSearch` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistryidsearch) -* [On-Premises/Cloud](/reference/graphql/index.md#giftregistryidsearch) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistryidsearch) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/type-search.md b/src/pages/graphql/schema/gift-registry/queries/type-search.md index 0cf7fff38..dec81f9f2 100644 --- a/src/pages/graphql/schema/gift-registry/queries/type-search.md +++ b/src/pages/graphql/schema/gift-registry/queries/type-search.md @@ -25,7 +25,7 @@ The `giftRegistryTypeSearch` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistrytypesearch) -* [On-Premises/Cloud](/reference/graphql/index.md#giftregistrytypesearch) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistrytypesearch) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/types.md b/src/pages/graphql/schema/gift-registry/queries/types.md index bb173a38c..d69e7cad3 100644 --- a/src/pages/graphql/schema/gift-registry/queries/types.md +++ b/src/pages/graphql/schema/gift-registry/queries/types.md @@ -21,7 +21,7 @@ The `giftRegistryTypes` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistrytypes) -* [On-Premises/Cloud](/reference/graphql/index.md#giftregistrytypes) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistrytypes) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md b/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md index 42da33a0c..d19a592cd 100644 --- a/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md +++ b/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md @@ -18,7 +18,7 @@ The `CreditMemoItemInterface` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#creditmemoiteminterface) -* [On-Premises/Cloud](/reference/graphql/index.md#creditmemoiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#creditmemoiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/invoice-item.md b/src/pages/graphql/schema/orders/interfaces/invoice-item.md index 139e550dd..2d233de45 100644 --- a/src/pages/graphql/schema/orders/interfaces/invoice-item.md +++ b/src/pages/graphql/schema/orders/interfaces/invoice-item.md @@ -18,7 +18,7 @@ The `InvoiceItemInterface` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#invoiceiteminterface) -* [On-Premises/Cloud](/reference/graphql/index.md#invoiceiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#invoiceiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/order-item.md b/src/pages/graphql/schema/orders/interfaces/order-item.md index d368f6de7..adf07d0de 100644 --- a/src/pages/graphql/schema/orders/interfaces/order-item.md +++ b/src/pages/graphql/schema/orders/interfaces/order-item.md @@ -18,7 +18,7 @@ The `OrderItemInterface` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#orderiteminterface) -* [On-Premises/Cloud](/reference/graphql/index.md#orderiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#orderiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/shipment-item.md b/src/pages/graphql/schema/orders/interfaces/shipment-item.md index f8fc35285..1c6e1b470 100644 --- a/src/pages/graphql/schema/orders/interfaces/shipment-item.md +++ b/src/pages/graphql/schema/orders/interfaces/shipment-item.md @@ -17,7 +17,7 @@ The `ShipmentItemInterface` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#shipmentiteminterface) -* [On-Premises/Cloud](/reference/graphql/index.md#shipmentiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#shipmentiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/add-return-comment.md b/src/pages/graphql/schema/orders/mutations/add-return-comment.md index 438978073..2f7b744c9 100644 --- a/src/pages/graphql/schema/orders/mutations/add-return-comment.md +++ b/src/pages/graphql/schema/orders/mutations/add-return-comment.md @@ -21,7 +21,7 @@ The `addReturnComment` reference provides detailed information about the types a * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addreturncomment) -* [On-Premises/Cloud](/reference/graphql/index.md#addreturncomment) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addreturncomment) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/add-return-tracking.md b/src/pages/graphql/schema/orders/mutations/add-return-tracking.md index a1652df3d..4584c7f9d 100644 --- a/src/pages/graphql/schema/orders/mutations/add-return-tracking.md +++ b/src/pages/graphql/schema/orders/mutations/add-return-tracking.md @@ -21,7 +21,7 @@ The `addReturnTracking` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addreturntracking) -* [On-Premises/Cloud](/reference/graphql/index.md#addreturntracking) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addreturntracking) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/cancel-order.md b/src/pages/graphql/schema/orders/mutations/cancel-order.md index c21746eff..ccd805934 100644 --- a/src/pages/graphql/schema/orders/mutations/cancel-order.md +++ b/src/pages/graphql/schema/orders/mutations/cancel-order.md @@ -27,7 +27,7 @@ The `cancelOrder` reference provides detailed information about the types and fi * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cancelorder) -* [On-Premises/Cloud](/reference/graphql/index.md#cancelorder) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#cancelorder) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md b/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md index 43a3211e8..d4e8cf535 100644 --- a/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md +++ b/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md @@ -27,7 +27,7 @@ The `confirmCancelOrder` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#confirmcancelorder) -* [On-Premises/Cloud](/reference/graphql/index.md#confirmcancelorder) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#confirmcancelorder) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/confirm-return.md b/src/pages/graphql/schema/orders/mutations/confirm-return.md index 6dde376c5..4ac5e4142 100644 --- a/src/pages/graphql/schema/orders/mutations/confirm-return.md +++ b/src/pages/graphql/schema/orders/mutations/confirm-return.md @@ -23,7 +23,7 @@ The `confirmReturn` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#confirmreturn) -* [On-Premises/Cloud](/reference/graphql/index.md#confirmreturn) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#confirmreturn) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md b/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md index 9d91516a2..e575f10df 100644 --- a/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md +++ b/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md @@ -21,7 +21,7 @@ The `removeReturnTracking` reference provides detailed information about the typ * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removereturntracking) -* [On-Premises/Cloud](/reference/graphql/index.md#removereturntracking) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removereturntracking) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/reorder-items.md b/src/pages/graphql/schema/orders/mutations/reorder-items.md index 5a7833df6..fb509bc25 100644 --- a/src/pages/graphql/schema/orders/mutations/reorder-items.md +++ b/src/pages/graphql/schema/orders/mutations/reorder-items.md @@ -29,7 +29,7 @@ The `reorderItems` reference provides detailed information about the types and f * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#reorderitems) -* [On-Premises/Cloud](/reference/graphql/index.md#reorderitems) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#reorderitems) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md b/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md index 1cd7bf31f..8167e34c9 100644 --- a/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md +++ b/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md @@ -25,7 +25,7 @@ The `requestGuestOrderCancel` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestguestordercancel) -* [On-Premises/Cloud](/reference/graphql/index.md#requestguestordercancel) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestguestordercancel) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/request-guest-return.md b/src/pages/graphql/schema/orders/mutations/request-guest-return.md index d81d37c62..080045eed 100644 --- a/src/pages/graphql/schema/orders/mutations/request-guest-return.md +++ b/src/pages/graphql/schema/orders/mutations/request-guest-return.md @@ -33,7 +33,7 @@ The `requestGuestReturn` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestguestreturn) -* [On-Premises/Cloud](/reference/graphql/index.md#requestguestreturn) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestguestreturn) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/request-return.md b/src/pages/graphql/schema/orders/mutations/request-return.md index fa9b7cb20..f552fcd50 100644 --- a/src/pages/graphql/schema/orders/mutations/request-return.md +++ b/src/pages/graphql/schema/orders/mutations/request-return.md @@ -32,7 +32,7 @@ The `requestReturn` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestreturn) -* [On-Premises/Cloud](/reference/graphql/index.md#requestreturn) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestreturn) ## Example usage 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 a8a3fefe7..d06fd34d8 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 @@ -18,7 +18,7 @@ The `guestOrderByToken` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#guestorderbytoken) -* [On-Premises/Cloud](/reference/graphql/index.md#guestorderbytoken) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#guestorderbytoken) ## 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 965673db6..953b03927 100644 --- a/src/pages/graphql/schema/orders/queries/guest-order.md +++ b/src/pages/graphql/schema/orders/queries/guest-order.md @@ -17,7 +17,7 @@ The `guestOrder` reference provides detailed information about the types and fie * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#guestorder) -* [On-Premises/Cloud](/reference/graphql/index.md#guestorder) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#guestorder) ## Example usage diff --git a/src/pages/graphql/schema/products/interfaces/attributes.md b/src/pages/graphql/schema/products/interfaces/attributes.md index bf08dea24..a8e2140a3 100644 --- a/src/pages/graphql/schema/products/interfaces/attributes.md +++ b/src/pages/graphql/schema/products/interfaces/attributes.md @@ -5,11 +5,11 @@ description: Any type that implements ProductInterface contains all the base att # ProductInterface attributes -Any type that implements [`ProductInterface`](/reference/graphql/index.md#productinterface) contains all the base attributes necessary for the frontend of the product model. +Any type that implements [`ProductInterface`](/reference/graphql/latest/index.md#productinterface) contains all the base attributes necessary for the frontend of the product model. The `items` that are returned in a `ProductInterface` array can also contain attributes from resources external to the `CatalogGraphQl` module: - Custom and extension attributes defined in any attribute set -- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) +- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) - Product types that define their own implementation of `ProductInterface` including: - [SimpleProduct](types/simple.md) - [BundleProduct](types/bundle.md) diff --git a/src/pages/graphql/schema/products/interfaces/category.md b/src/pages/graphql/schema/products/interfaces/category.md index c7d5dae9f..8a3366745 100644 --- a/src/pages/graphql/schema/products/interfaces/category.md +++ b/src/pages/graphql/schema/products/interfaces/category.md @@ -5,4 +5,4 @@ description: CategoryInterface defines attributes that can be returned in the ca # CategoryInterface attributes -[`CategoryInterface`](/reference/graphql/index.md#categoryinterface) defines attributes that can be returned in the [`categoryList` query](../queries/category-list.md), [`categories` query](../queries/categories.md), and the [`products` query](../queries/products.md). +[`CategoryInterface`](/reference/graphql/latest/index.md#categoryinterface) defines attributes that can be returned in the [`categoryList` query](../queries/category-list.md), [`categories` query](../queries/categories.md), and the [`products` query](../queries/products.md). diff --git a/src/pages/graphql/schema/products/interfaces/customizable-option.md b/src/pages/graphql/schema/products/interfaces/customizable-option.md index d0868bc88..c4b9bef3d 100644 --- a/src/pages/graphql/schema/products/interfaces/customizable-option.md +++ b/src/pages/graphql/schema/products/interfaces/customizable-option.md @@ -7,7 +7,7 @@ description: Customizable options for a product provide a way to offer customers Customizable options for a product provide a way to offer customers a selection of options with a variety of text, selection, and date input types. All product types can contain customizable options. -[`CustomizableOptionInterface`](/reference/graphql/index.md#customizableoptioninterface) is defined in the `CatalogGraphQl` module, and its attributes can be used in any `products` query. This interface returns basic information about a customizable option and can be implemented by several types of configurable options: +[`CustomizableOptionInterface`](/reference/graphql/latest/index.md#customizableoptioninterface) is defined in the `CatalogGraphQl` module, and its attributes can be used in any `products` query. This interface returns basic information about a customizable option and can be implemented by several types of configurable options: * Text area * Checkbox diff --git a/src/pages/graphql/schema/products/interfaces/index.md b/src/pages/graphql/schema/products/interfaces/index.md index 2c30588f0..b59c13abc 100644 --- a/src/pages/graphql/schema/products/interfaces/index.md +++ b/src/pages/graphql/schema/products/interfaces/index.md @@ -5,11 +5,11 @@ description: Any type that implements ProductInterface contains all the base att # Product interfaces and attributes -Any type that implements [`ProductInterface`](/reference/graphql/index.md#productinterface) contains all the base attributes necessary for the frontend of the product model. +Any type that implements [`ProductInterface`](/reference/graphql/latest/index.md#productinterface) contains all the base attributes necessary for the frontend of the product model. The `items` that are returned in a `ProductInterface` array can also contain attributes from resources external to the `CatalogGraphQl` module: - Custom and extension attributes defined in any attribute set -- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) +- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) - Product types that define their own implementation of `ProductInterface` including: - [`SimpleProduct`](types/simple.md) - [`BundleProduct`](types/bundle.md) diff --git a/src/pages/graphql/schema/products/interfaces/routable.md b/src/pages/graphql/schema/products/interfaces/routable.md index 92a48a780..29c8a56f5 100644 --- a/src/pages/graphql/schema/products/interfaces/routable.md +++ b/src/pages/graphql/schema/products/interfaces/routable.md @@ -5,7 +5,7 @@ description: Some entities are "routable", meaning that they have URLs and can s # RoutableInterface attributes -Some entities are "routable", meaning that they have URLs and can serve as the model for a rendered page. The following implementations of the [`RoutableInterface`](/reference/graphql/index.md#routableinterface) allow you to return details in the [`route` query](../queries/route.md). `RoutableUrl` is returned when the URL is not linked to an entity. +Some entities are "routable", meaning that they have URLs and can serve as the model for a rendered page. The following implementations of the [`RoutableInterface`](/reference/graphql/latest/index.md#routableinterface) allow you to return details in the [`route` query](../queries/route.md). `RoutableUrl` is returned when the URL is not linked to an entity. * [BundleProduct](types/bundle.md) * [CategoryTree](../queries/category-list.md#return-the-category-tree-of-a-top-level-category) diff --git a/src/pages/graphql/schema/products/interfaces/types/bundle.md b/src/pages/graphql/schema/products/interfaces/types/bundle.md index 430c9f410..fa443b048 100644 --- a/src/pages/graphql/schema/products/interfaces/types/bundle.md +++ b/src/pages/graphql/schema/products/interfaces/types/bundle.md @@ -5,12 +5,12 @@ description: The BundleProduct data type implements the following interfaces: # Bundle product data types -The [`BundleProduct`](/reference/graphql/index.md#bundleproduct) data type implements the following interfaces: +The [`BundleProduct`](/reference/graphql/latest/index.md#bundleproduct) data type implements the following interfaces: -- [ProductInterface](/reference/graphql/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/index.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) Attributes that are specific to bundle products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/interfaces/types/configurable.md b/src/pages/graphql/schema/products/interfaces/types/configurable.md index bfe07ccdd..19a474da7 100644 --- a/src/pages/graphql/schema/products/interfaces/types/configurable.md +++ b/src/pages/graphql/schema/products/interfaces/types/configurable.md @@ -7,10 +7,10 @@ description: The ConfigurableProduct data type implements the following interfac The `ConfigurableProduct` data type implements the following interfaces: -- [ProductInterface](/reference/graphql/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/index.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) Attributes that are specific to configurable products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/interfaces/types/downloadable.md b/src/pages/graphql/schema/products/interfaces/types/downloadable.md index ac5c197c8..862f3d216 100644 --- a/src/pages/graphql/schema/products/interfaces/types/downloadable.md +++ b/src/pages/graphql/schema/products/interfaces/types/downloadable.md @@ -5,7 +5,7 @@ description: The DownloadableProduct data type implements ProductInterface and C # Downloadable product data types -The `DownloadableProduct` data type implements [`ProductInterface`](/reference/graphql/index.md#productinterface) and [`CustomizableProductInterface`](/reference/graphql/index.md#customizableproductinterface). As a result, attributes that are specific to downloadable products can be used when performing a [`products`](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/index.md#routableinterface). +The `DownloadableProduct` data type implements [`ProductInterface`](/reference/graphql/latest/index.md#productinterface) and [`CustomizableProductInterface`](/reference/graphql/latest/index.md#customizableproductinterface). As a result, attributes that are specific to downloadable products can be used when performing a [`products`](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/latest/index.md#routableinterface). ## Sample query diff --git a/src/pages/graphql/schema/products/interfaces/types/gift-card.md b/src/pages/graphql/schema/products/interfaces/types/gift-card.md index 090dc42d2..8ff9d672f 100644 --- a/src/pages/graphql/schema/products/interfaces/types/gift-card.md +++ b/src/pages/graphql/schema/products/interfaces/types/gift-card.md @@ -11,10 +11,10 @@ The `GiftCardProduct` data type defines properties of a gift card, including the It implements the following interfaces: -- [ProductInterface](/reference/graphql/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/index.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) ## Sample query diff --git a/src/pages/graphql/schema/products/interfaces/types/grouped.md b/src/pages/graphql/schema/products/interfaces/types/grouped.md index b84180e37..e81ad8b7c 100644 --- a/src/pages/graphql/schema/products/interfaces/types/grouped.md +++ b/src/pages/graphql/schema/products/interfaces/types/grouped.md @@ -5,7 +5,7 @@ description: The GroupedProduct data type implements ProductInterface and Physic # Grouped product data types -The `GroupedProduct` data type implements [ProductInterface](/reference/graphql/index.md#productinterface) and [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface). As a result, attributes that are specific to grouped products can be used when performing a [products](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/index.md#routableinterface). +The `GroupedProduct` data type implements [ProductInterface](/reference/graphql/latest/index.md#productinterface) and [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface). As a result, attributes that are specific to grouped products can be used when performing a [products](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/latest/index.md#routableinterface). ## Sample query diff --git a/src/pages/graphql/schema/products/interfaces/types/index.md b/src/pages/graphql/schema/products/interfaces/types/index.md index 25c31f82c..b1a231493 100644 --- a/src/pages/graphql/schema/products/interfaces/types/index.md +++ b/src/pages/graphql/schema/products/interfaces/types/index.md @@ -5,17 +5,17 @@ description: Adobe Commerce and Magento Open Source provides multiple product ty # Product interface implementations -Adobe Commerce and Magento Open Source provides multiple product types, and most of these product types have specialized attributes that are not defined in the [`ProductInterface`(/reference/graphql/index.md#productinterface)]. +Adobe Commerce and Magento Open Source provides multiple product types, and most of these product types have specialized attributes that are not defined in the [`ProductInterface`(/reference/graphql/latest/index.md#productinterface)]. | Product type | Implements | Has product-specific attributes? | | --- | --- | --- | -| [BundleProduct](bundle.md) | ProductInterface, [PhysicalProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [ConfigurableProduct](configurable.md) | [ProductInterface](/reference/graphql/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [DownloadableProduct](downloadable.md) | [ProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [GiftCardProduct](gift-card.md) | [ProductInterface](/reference/graphql/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)| Yes | -| [GroupedProduct](grouped.md) | [ProductInterface](/reference/graphql/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [SimpleProduct](simple.md) | [ProductInterface](/reference/graphql/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | -| [VirtualProduct](virtual.md) | [ProductInterface](/reference/graphql/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | +| [BundleProduct](bundle.md) | ProductInterface, [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [ConfigurableProduct](configurable.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [DownloadableProduct](downloadable.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [GiftCardProduct](gift-card.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)| Yes | +| [GroupedProduct](grouped.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [SimpleProduct](simple.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | +| [VirtualProduct](virtual.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | ## Query for product-specific attributes diff --git a/src/pages/graphql/schema/products/interfaces/types/simple.md b/src/pages/graphql/schema/products/interfaces/types/simple.md index c81875590..c32c5fdcd 100644 --- a/src/pages/graphql/schema/products/interfaces/types/simple.md +++ b/src/pages/graphql/schema/products/interfaces/types/simple.md @@ -7,10 +7,10 @@ description: The SimpleProduct data type implements the following interfaces: The `SimpleProduct` data type implements the following interfaces: -- [ProductInterface](/reference/graphql/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/index.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) Attributes that are specific to the simple products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/interfaces/types/virtual.md b/src/pages/graphql/schema/products/interfaces/types/virtual.md index dcae7e69c..1f437f9b8 100644 --- a/src/pages/graphql/schema/products/interfaces/types/virtual.md +++ b/src/pages/graphql/schema/products/interfaces/types/virtual.md @@ -7,9 +7,9 @@ description: The VirtualProduct data type implements the following interfaces: The `VirtualProduct` data type implements the following interfaces: -- [ProductInterface](/reference/graphql/index.md#productinterface) -- [CustomizableProductInterface](/reference/graphql/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/index.md#productinterface) +- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) Attributes that are specific to the virtual products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md b/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md index 41a23c481..c4b561645 100644 --- a/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md @@ -27,7 +27,7 @@ The `addProductsToCompareList` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstocomparelist) -* [On-Premises/Cloud](/reference/graphql/index.md#addproductstocomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstocomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/assign-compare-list.md b/src/pages/graphql/schema/products/mutations/assign-compare-list.md index 7e1e8e89f..6a5774301 100644 --- a/src/pages/graphql/schema/products/mutations/assign-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/assign-compare-list.md @@ -27,7 +27,7 @@ The `assignCompareListToCustomer` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#assigncomparelisttocustomer) -* [On-Premises/Cloud](/reference/graphql/index.md#assigncomparelisttocustomer) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#assigncomparelisttocustomer) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/create-compare-list.md b/src/pages/graphql/schema/products/mutations/create-compare-list.md index d161f0ca2..464c3fab9 100644 --- a/src/pages/graphql/schema/products/mutations/create-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/create-compare-list.md @@ -27,7 +27,7 @@ The `createCompareList` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcomparelist) -* [On-Premises/Cloud](/reference/graphql/index.md#createcomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/create-review.md b/src/pages/graphql/schema/products/mutations/create-review.md index cc15a0db6..4fe6b0057 100644 --- a/src/pages/graphql/schema/products/mutations/create-review.md +++ b/src/pages/graphql/schema/products/mutations/create-review.md @@ -16,7 +16,7 @@ The `createProductReview` mutation adds a review for the specified product. Use ## Reference -The [`createProductReview`](/reference/graphql/index.md#createproductreview) reference provides detailed information about the types and fields defined in this mutation. +The [`createProductReview`](/reference/graphql/latest/index.md#createproductreview) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/delete-compare-list.md b/src/pages/graphql/schema/products/mutations/delete-compare-list.md index ff5efe91a..50582840d 100644 --- a/src/pages/graphql/schema/products/mutations/delete-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/delete-compare-list.md @@ -28,7 +28,7 @@ The `deleteCompareList` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecomparelist) -* [On-Premises/Cloud](/reference/graphql/index.md#deletecomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md b/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md index d87400bc8..4a4edfc03 100644 --- a/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md @@ -27,7 +27,7 @@ The `removeProductsFromCompareList` reference provides detailed information abou * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removeproductsfromcomparelist) -* [On-Premises/Cloud](/reference/graphql/index.md#removeproductsfromcomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removeproductsfromcomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/queries/categories.md b/src/pages/graphql/schema/products/queries/categories.md index 6876f60a6..a2bcf1080 100644 --- a/src/pages/graphql/schema/products/queries/categories.md +++ b/src/pages/graphql/schema/products/queries/categories.md @@ -40,7 +40,7 @@ categories(filters: CategoryFilterInput pageSize: Int currentPage: Int): Categor ## Reference -The [`categories`](/reference/graphql/index.md#categories) reference provides detailed information about the types and fields defined in this query. +The [`categories`](/reference/graphql/latest/index.md#categories) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/category-list.md b/src/pages/graphql/schema/products/queries/category-list.md index a9e353a0b..45eb3b741 100644 --- a/src/pages/graphql/schema/products/queries/category-list.md +++ b/src/pages/graphql/schema/products/queries/category-list.md @@ -42,7 +42,7 @@ categoryList ( ## Reference -The [`categoryList`](/reference/graphql/index.md#categorylist) reference provides detailed information about the types and fields defined in this query. +The [`categoryList`](/reference/graphql/latest/index.md#categorylist) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/category.md b/src/pages/graphql/schema/products/queries/category.md index 21431e1f0..b8ee16b6e 100644 --- a/src/pages/graphql/schema/products/queries/category.md +++ b/src/pages/graphql/schema/products/queries/category.md @@ -28,7 +28,7 @@ category ( ## Reference -The [`category`](/reference/graphql/index.md#category) reference provides detailed information about the types and fields defined in this query. +The [`category`](/reference/graphql/latest/index.md#category) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/compare-list.md b/src/pages/graphql/schema/products/queries/compare-list.md index 8e5ef9a3c..a374aae85 100644 --- a/src/pages/graphql/schema/products/queries/compare-list.md +++ b/src/pages/graphql/schema/products/queries/compare-list.md @@ -21,7 +21,7 @@ The `compareList` reference provides detailed information about the types and fi * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#comparelist) -* [On-Premises/Cloud](/reference/graphql/index.md#comparelist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#comparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md b/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md index f53efa6e5..dd359b29b 100644 --- a/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md +++ b/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md @@ -18,7 +18,7 @@ Use the [`createProductReview` mutation](../mutations/create-review.md) to add a ## Reference -The [`productReviewRatingsMetadata`](/reference/graphql/index.md#productreviewratingsmetadata) reference provides detailed information about the types and fields defined in this query. +The [`productReviewRatingsMetadata`](/reference/graphql/latest/index.md#productreviewratingsmetadata) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/products.md b/src/pages/graphql/schema/products/queries/products.md index 6655f0aa5..21fb3cff2 100644 --- a/src/pages/graphql/schema/products/queries/products.md +++ b/src/pages/graphql/schema/products/queries/products.md @@ -28,7 +28,7 @@ products( ## Reference -The [`products`](/reference/graphql/index.md#products) reference provides detailed information about the types and fields defined in this query. +The [`products`](/reference/graphql/latest/index.md#products) reference provides detailed information about the types and fields defined in this query. ## Input attributes diff --git a/src/pages/graphql/schema/products/queries/route.md b/src/pages/graphql/schema/products/queries/route.md index f831e4c73..3973b6f29 100644 --- a/src/pages/graphql/schema/products/queries/route.md +++ b/src/pages/graphql/schema/products/queries/route.md @@ -18,7 +18,7 @@ The `route` query returns the canonical URL for a specified product, category, o ## Reference -The [`route`](/reference/graphql/index.md#route) reference provides detailed information about the types and fields defined in this query. +The [`route`](/reference/graphql/latest/index.md#route) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/url-resolver.md b/src/pages/graphql/schema/products/queries/url-resolver.md index cb7b977b6..5f225fed6 100644 --- a/src/pages/graphql/schema/products/queries/url-resolver.md +++ b/src/pages/graphql/schema/products/queries/url-resolver.md @@ -22,7 +22,7 @@ The `urlResolver` query returns the canonical URL for a specified product, categ ## Reference -The [`urlResolver`](/reference/graphql/index.md#urlresolver) reference provides detailed information about the types and fields defined in this query. +The [`urlResolver`](/reference/graphql/latest/index.md#urlresolver) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/mutations/contact-us.md b/src/pages/graphql/schema/store/mutations/contact-us.md index fd5d7695a..6fe9d5c07 100644 --- a/src/pages/graphql/schema/store/mutations/contact-us.md +++ b/src/pages/graphql/schema/store/mutations/contact-us.md @@ -17,7 +17,7 @@ The `contactUs` reference provides detailed information about the types and fiel * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#contactus) -* [On-Premises/Cloud](/reference/graphql/index.md#contactus) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#contactus) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/available-stores.md b/src/pages/graphql/schema/store/queries/available-stores.md index f3df20eb2..438791b13 100644 --- a/src/pages/graphql/schema/store/queries/available-stores.md +++ b/src/pages/graphql/schema/store/queries/available-stores.md @@ -21,7 +21,7 @@ The `availableStores` reference provides detailed information about the types an * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#availablestores) -* [On-Premises/Cloud](/reference/graphql/index.md#availablestores) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#availablestores) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/cms-blocks.md b/src/pages/graphql/schema/store/queries/cms-blocks.md index b2f1fe0ca..57f2cb125 100644 --- a/src/pages/graphql/schema/store/queries/cms-blocks.md +++ b/src/pages/graphql/schema/store/queries/cms-blocks.md @@ -18,7 +18,7 @@ Return the contents of one or more CMS blocks: ## Reference -The [`cmsBlocks`](/reference/graphql/index.md#cmsblocks) reference provides detailed information about the types and fields defined in this query. +The [`cmsBlocks`](/reference/graphql/latest/index.md#cmsblocks) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/cms-page.md b/src/pages/graphql/schema/store/queries/cms-page.md index 4628eab68..54a2f93c3 100644 --- a/src/pages/graphql/schema/store/queries/cms-page.md +++ b/src/pages/graphql/schema/store/queries/cms-page.md @@ -18,7 +18,7 @@ Return the contents of a CMS page: ## Reference -The [`cmsPage`](/reference/graphql/index.md#cmspage) reference provides detailed information about the types and fields defined in this query. +The [`cmsPage`](/reference/graphql/latest/index.md#cmspage) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/countries.md b/src/pages/graphql/schema/store/queries/countries.md index b0f967ddc..dd179c5dc 100644 --- a/src/pages/graphql/schema/store/queries/countries.md +++ b/src/pages/graphql/schema/store/queries/countries.md @@ -19,7 +19,7 @@ The `countries` reference provides detailed information about the types and fiel * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#countries) -* [On-Premises/Cloud](/reference/graphql/index.md#countries) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#countries) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/country.md b/src/pages/graphql/schema/store/queries/country.md index 18b9dfb93..e1fc86824 100644 --- a/src/pages/graphql/schema/store/queries/country.md +++ b/src/pages/graphql/schema/store/queries/country.md @@ -19,7 +19,7 @@ The `country` reference provides detailed information about the types and fields * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#country) -* [On-Premises/Cloud](/reference/graphql/index.md#country) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#country) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/currency.md b/src/pages/graphql/schema/store/queries/currency.md index b8fdf490f..c38ccdb4f 100644 --- a/src/pages/graphql/schema/store/queries/currency.md +++ b/src/pages/graphql/schema/store/queries/currency.md @@ -17,7 +17,7 @@ The `currency` reference provides detailed information about the types and field * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#currency) -* [On-Premises/Cloud](/reference/graphql/index.md#currency) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#currency) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/dynamic-blocks.md b/src/pages/graphql/schema/store/queries/dynamic-blocks.md index e22952985..214ffd345 100644 --- a/src/pages/graphql/schema/store/queries/dynamic-blocks.md +++ b/src/pages/graphql/schema/store/queries/dynamic-blocks.md @@ -52,7 +52,7 @@ dynamicBlocks( ## Reference -The [`dynamicBlocks`](/reference/graphql/index.md#dynamicblocks) reference provides detailed information about the types and fields defined in this query. +The [`dynamicBlocks`](/reference/graphql/latest/index.md#dynamicblocks) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/recaptcha-form-config.md b/src/pages/graphql/schema/store/queries/recaptcha-form-config.md index 4832a9f1d..eedd95fd3 100644 --- a/src/pages/graphql/schema/store/queries/recaptcha-form-config.md +++ b/src/pages/graphql/schema/store/queries/recaptcha-form-config.md @@ -19,7 +19,7 @@ The `recaptchaFormConfig` reference provides detailed information about the type * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#recaptchaformconfig) -* [On-Premises/Cloud](/reference/graphql/index.md#recaptchav3config) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#recaptchav3config) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md b/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md index b276b8649..30ffbdadc 100644 --- a/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md +++ b/src/pages/graphql/schema/store/queries/recaptcha-v3-config.md @@ -17,7 +17,7 @@ The `recaptchaV3Config` reference provides detailed information about the types * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#recaptchav3config) -* [On-Premises/Cloud](/reference/graphql/index.md#recaptchav3config) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#recaptchav3config) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/store-config.md b/src/pages/graphql/schema/store/queries/store-config.md index 5604bc559..d8ac90123 100644 --- a/src/pages/graphql/schema/store/queries/store-config.md +++ b/src/pages/graphql/schema/store/queries/store-config.md @@ -17,7 +17,7 @@ The `storeConfig` reference provides detailed information about the types and fi * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#storeconfig) -* [On-Premises/Cloud](/reference/graphql/index.md#storeconfig) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#storeconfig) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/interfaces/wishlist.md b/src/pages/graphql/schema/wishlist/interfaces/wishlist.md index fe3afc148..c5b2e2cea 100644 --- a/src/pages/graphql/schema/wishlist/interfaces/wishlist.md +++ b/src/pages/graphql/schema/wishlist/interfaces/wishlist.md @@ -21,7 +21,7 @@ The `WishlistItemInterface` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#wishlistiteminterface) -* [On-Premises/Cloud](/reference/graphql/index.md#wishlistiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#wishlistiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md b/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md index 11348207a..5f1c8fffb 100644 --- a/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md +++ b/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md @@ -28,7 +28,7 @@ The `addWishlistItemsToCart` reference provides detailed information about the t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addwishlistitemstocart) -* [On-Premises/Cloud](/reference/graphql/index.md#addwishlistitemstocart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addwishlistitemstocart) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/add-products.md b/src/pages/graphql/schema/wishlist/mutations/add-products.md index b8989bdce..7655501db 100644 --- a/src/pages/graphql/schema/wishlist/mutations/add-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/add-products.md @@ -38,7 +38,7 @@ The `addProductsToWishlist` reference provides detailed information about the ty * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstowishlist) -* [On-Premises/Cloud](/reference/graphql/index.md#addproductstowishlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstowishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/clear.md b/src/pages/graphql/schema/wishlist/mutations/clear.md index 713df0d6e..8f233e30f 100644 --- a/src/pages/graphql/schema/wishlist/mutations/clear.md +++ b/src/pages/graphql/schema/wishlist/mutations/clear.md @@ -37,7 +37,7 @@ mutation { [//]: # (## Reference) [//]: # () -[//]: # (The [`clearWishlist`](/reference/graphql/index.md#clearwishlist) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`clearWishlist`](/reference/graphql/latest/index.md#clearwishlist) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/copy-products.md b/src/pages/graphql/schema/wishlist/mutations/copy-products.md index f5923e57f..90697a7be 100644 --- a/src/pages/graphql/schema/wishlist/mutations/copy-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/copy-products.md @@ -33,7 +33,7 @@ The `copyProductsBetweenWishlists` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#copyproductsbetweenwishlists) -* [On-Premises/Cloud](/reference/graphql/index.md#copyproductsbetweenwishlists) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#copyproductsbetweenwishlists) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/create.md b/src/pages/graphql/schema/wishlist/mutations/create.md index 1ac67ec05..573375819 100644 --- a/src/pages/graphql/schema/wishlist/mutations/create.md +++ b/src/pages/graphql/schema/wishlist/mutations/create.md @@ -35,7 +35,7 @@ The `createWishlist` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createwishlist) -* [On-Premises/Cloud](/reference/graphql/index.md#createwishlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#createwishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/delete.md b/src/pages/graphql/schema/wishlist/mutations/delete.md index 2e97d3bf1..ad3d433c8 100644 --- a/src/pages/graphql/schema/wishlist/mutations/delete.md +++ b/src/pages/graphql/schema/wishlist/mutations/delete.md @@ -25,7 +25,7 @@ The `deleteWishlist` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletewishlist) -* [On-Premises/Cloud](/reference/graphql/index.md#deletewishlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletewishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/move-products.md b/src/pages/graphql/schema/wishlist/mutations/move-products.md index 415d35486..2a939bec7 100644 --- a/src/pages/graphql/schema/wishlist/mutations/move-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/move-products.md @@ -34,7 +34,7 @@ The `moveProductsBetweenWishlists` reference provides detailed information about * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#moveproductsbetweenwishlists) -* [On-Premises/Cloud](/reference/graphql/index.md#moveproductsbetweenwishlists) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#moveproductsbetweenwishlists) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/remove-products.md b/src/pages/graphql/schema/wishlist/mutations/remove-products.md index 8bfc38172..8d9626049 100644 --- a/src/pages/graphql/schema/wishlist/mutations/remove-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/remove-products.md @@ -28,7 +28,7 @@ The `removeProductsFromWishlist` reference provides detailed information about t * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removeproductsfromwishlist) -* [On-Premises/Cloud](/reference/graphql/index.md#removeproductsfromwishlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#removeproductsfromwishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/update-products.md b/src/pages/graphql/schema/wishlist/mutations/update-products.md index 9c19350ec..1366c9d6c 100644 --- a/src/pages/graphql/schema/wishlist/mutations/update-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/update-products.md @@ -32,7 +32,7 @@ The `updateProductsInWishlist` reference provides detailed information about the * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updateproductsinwishlist) -* [On-Premises/Cloud](/reference/graphql/index.md#updateproductsinwishlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updateproductsinwishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/update.md b/src/pages/graphql/schema/wishlist/mutations/update.md index 93ba2944f..47eb00011 100644 --- a/src/pages/graphql/schema/wishlist/mutations/update.md +++ b/src/pages/graphql/schema/wishlist/mutations/update.md @@ -35,7 +35,7 @@ The `updateWishlist` reference provides detailed information about the types and * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatewishlist) -* [On-Premises/Cloud](/reference/graphql/index.md#updatewishlist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatewishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/queries/wishlist.md b/src/pages/graphql/schema/wishlist/queries/wishlist.md index 67c9f0bc3..fbee27b81 100644 --- a/src/pages/graphql/schema/wishlist/queries/wishlist.md +++ b/src/pages/graphql/schema/wishlist/queries/wishlist.md @@ -20,7 +20,7 @@ Use the `wishlist` query to retrieve information about a customer's wish list. [ ## Reference -The [`wishlist`](/reference/graphql/index.md#wishlist) reference provides detailed information about the types and fields defined in this query. +The [`wishlist`](/reference/graphql/latest/index.md#wishlist) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-mutations.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-mutations.md index f768f0b05..20305cb56 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-mutations.md @@ -224,7 +224,7 @@ mutation addProductsToCart( ```json { - "cartId": "abc123", + "cartId": "xyz789", "cartItems": [CartItemInput] } ``` @@ -288,9 +288,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -550,10 +550,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -566,7 +563,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } } } @@ -784,7 +781,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": [4]} +{"wishlistId": 4, "wishlistItemIds": ["4"]} ``` ##### Response @@ -796,7 +793,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": true, + "status": false, "wishlist": Wishlist } } @@ -914,7 +911,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -1137,7 +1134,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -1156,11 +1153,11 @@ mutation assignCustomerToGuestCart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "is_virtual": true, "items": [CartItemInterface], "prices": CartPrices, @@ -1235,8 +1232,8 @@ Change the password for the logged-in customer. | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](#string) | The customer's original password. | +| `newPassword` - [`String!`](#string) | The customer's updated password. | #### Example @@ -1344,8 +1341,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "xyz789", - "newPassword": "abc123" + "currentPassword": "abc123", + "newPassword": "xyz789" } ``` @@ -1356,12 +1353,12 @@ mutation changeCustomerPassword( "data": { "changeCustomerPassword": { "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "compare_list": CompareList, - "created_at": "xyz789", - "date_of_birth": "abc123", - "default_billing": "abc123", - "default_shipping": "xyz789", + "created_at": "abc123", + "date_of_birth": "xyz789", + "default_billing": "xyz789", + "default_shipping": "abc123", "dob": "abc123", "email": "xyz789", "firstname": "xyz789", @@ -1370,12 +1367,12 @@ mutation changeCustomerPassword( "gift_registry": GiftRegistry, "group_id": 987, "id": 123, - "is_subscribed": false, + "is_subscribed": true, "job_title": "xyz789", - "lastname": "abc123", - "middlename": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -1443,7 +1440,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": true} + "clearCustomerCart": {"cart": Cart, "status": false} } } ``` @@ -1620,7 +1617,7 @@ mutation copyProductsBetweenWishlists( ```json { "sourceWishlistUid": "4", - "destinationWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemCopyInput] } ``` @@ -1873,9 +1870,9 @@ mutation createCompareList($input: CreateCompareListInput) { "data": { "createCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -1987,24 +1984,24 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "abc123", - "company": "abc123", + "company": "xyz789", "country_code": "AF", "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "customer_id": 123, - "default_billing": true, - "default_shipping": false, + "default_billing": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "xyz789", "id": 123, "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", + "middlename": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 987, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "xyz789", "vat_id": "abc123" @@ -2177,8 +2174,8 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { "createPayflowProToken": { "response_message": "abc123", "result": 123, - "result_code": 123, - "secure_token": "xyz789", + "result_code": 987, + "secure_token": "abc123", "secure_token_id": "xyz789" } } @@ -2333,13 +2330,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "abc123", - "description": "abc123", + "created_at": "xyz789", + "created_by": "xyz789", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } } } @@ -2498,7 +2495,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -2536,13 +2533,13 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyUser": {"success": false}}} +{"data": {"deleteCompanyUser": {"success": true}}} ``` @@ -2580,7 +2577,7 @@ mutation deleteCompareList($uid: ID!) { ##### Response ```json -{"data": {"deleteCompareList": {"result": false}}} +{"data": {"deleteCompareList": {"result": true}}} ``` @@ -2734,7 +2731,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "abc123"} +{"public_hash": "xyz789"} ``` ##### Response @@ -2744,7 +2741,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } } } @@ -2882,10 +2879,7 @@ mutation deleteRequisitionListItems( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -2932,7 +2926,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -2960,8 +2954,8 @@ Generate a token for specified customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -3098,7 +3092,7 @@ Transfer the contents of a guest cart into the cart of a logged-in customer. | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | +| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | | `destination_cart_id` - [`String`](#string) | The cart ID after the guest logs in. | #### Example @@ -3171,7 +3165,7 @@ mutation mergeCarts( ```json { "source_cart_id": "xyz789", - "destination_cart_id": "abc123" + "destination_cart_id": "xyz789" } ``` @@ -3193,13 +3187,13 @@ mutation mergeCarts( "billing_address": BillingCartAddress, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, "is_virtual": true, "items": [CartItemInterface], "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -3260,7 +3254,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } } @@ -3312,7 +3306,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, + "sourceRequisitionListUid": "4", "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } @@ -3380,7 +3374,7 @@ mutation moveProductsBetweenWishlists( ```json { "sourceWishlistUid": "4", - "destinationWishlistUid": "4", + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } ``` @@ -3451,7 +3445,7 @@ Convert the quote into an order. | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -3613,7 +3607,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -3784,7 +3778,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Response ```json -{"data": {"removeGiftRegistry": {"success": true}}} +{"data": {"removeGiftRegistry": {"success": false}}} ``` @@ -3825,7 +3819,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": ["4"]} +{"giftRegistryUid": 4, "itemsUid": [4]} ``` ##### Response @@ -4077,7 +4071,10 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": ["4"]} +{ + "wishlistId": "4", + "wishlistItemsIds": ["4"] +} ``` ##### Response @@ -4164,7 +4161,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -4319,7 +4316,7 @@ Request an email with a reset password token for the registered customer identif | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](#string) | The customer's email address. | #### Example @@ -4334,7 +4331,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -4405,9 +4402,9 @@ Reset a customer's password using the reset password token that the customer rec | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](#string) | The customer's new password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](#string) | The customer's new password. | #### Example @@ -4431,7 +4428,7 @@ mutation resetPassword( ```json { - "email": "xyz789", + "email": "abc123", "resetPasswordToken": "xyz789", "newPassword": "xyz789" } @@ -4440,7 +4437,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": true}} +{"data": {"resetPassword": false}} ``` @@ -5050,7 +5047,7 @@ Send an email about the gift registry to a list of invitees. | Name | Description | |------|-------------| | `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | | `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -5077,7 +5074,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -5101,7 +5098,7 @@ Subscribe the specified email to the store's newsletter. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | #### Example @@ -5118,7 +5115,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -5470,7 +5467,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 123, "input": CustomerAddressInput} +{"id": 987, "input": CustomerAddressInput} ``` ##### Response @@ -5479,28 +5476,28 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "customer_id": 987, - "default_billing": true, - "default_shipping": false, + "default_billing": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", "id": 123, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "xyz789", + "region_id": 987, + "street": ["xyz789"], + "suffix": "abc123", "telephone": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -5518,8 +5515,8 @@ Change the email address for the logged-in customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -5635,7 +5632,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "giftRegistry": UpdateGiftRegistryInput } ``` @@ -5850,7 +5847,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": "4", + "wishlistId": 4, "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -5924,9 +5921,9 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", + "created_at": "xyz789", "created_by": "abc123", - "description": "xyz789", + "description": "abc123", "name": "xyz789", "status": "ENABLED", "uid": 4, @@ -6092,8 +6089,8 @@ mutation updateWishlist( ```json { - "wishlistId": 4, - "name": "abc123", + "wishlistId": "4", + "name": "xyz789", "visibility": "PUBLIC" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-queries.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-queries.md index ea19b7bc4..1732aef2f 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-queries.md @@ -172,87 +172,87 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "absolute_footer": "abc123", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "abc123", + "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": "xyz789", - "autocomplete_on_storefront": true, + "autocomplete_on_storefront": false, "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "abc123", - "base_static_url": "abc123", - "base_url": "xyz789", + "base_link_url": "xyz789", + "base_media_url": "xyz789", + "base_static_url": "xyz789", + "base_url": "abc123", "braintree_cc_vault_active": "xyz789", "cart_gift_wrapping": "abc123", - "cart_printed_card": "xyz789", + "cart_printed_card": "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": false, "check_money_order_enabled": false, "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_min_order_total": "abc123", + "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": 987, - "check_money_order_title": "abc123", - "cms_home_page": "xyz789", - "cms_no_cookies": "abc123", - "cms_no_route": "abc123", + "check_money_order_sort_order": 123, + "check_money_order_title": "xyz789", + "cms_home_page": "abc123", + "cms_no_cookies": "xyz789", + "cms_no_route": "xyz789", "code": "xyz789", - "configurable_thumbnail_source": "abc123", - "copyright": "xyz789", + "configurable_thumbnail_source": "xyz789", + "copyright": "abc123", "default_description": "abc123", "default_display_currency_code": "abc123", - "default_keywords": "abc123", + "default_keywords": "xyz789", "default_title": "abc123", - "demonotice": 987, - "enable_multiple_wishlists": "xyz789", - "front": "abc123", - "grid_per_page": 987, + "demonotice": 123, + "enable_multiple_wishlists": "abc123", + "front": "xyz789", + "grid_per_page": 123, "grid_per_page_values": "xyz789", - "head_includes": "xyz789", + "head_includes": "abc123", "head_shortcut_icon": "abc123", "header_logo_src": "xyz789", "id": 123, - "is_default_store": false, - "is_default_store_group": true, + "is_default_store": true, + "is_default_store_group": false, "is_negotiable_quote_active": true, - "is_requisition_list_active": "abc123", + "is_requisition_list_active": "xyz789", "list_mode": "abc123", "list_per_page": 123, "list_per_page_values": "abc123", "locale": "abc123", - "logo_alt": "xyz789", + "logo_alt": "abc123", "logo_height": 987, "logo_width": 123, - "magento_reward_general_is_enabled": "xyz789", + "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": "xyz789", + "magento_reward_general_publish_history": "abc123", "magento_reward_points_invitation_customer": "xyz789", - "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_customer_limit": "xyz789", "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_register": "abc123", - "magento_reward_points_review": "xyz789", + "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "xyz789", "maximum_number_of_wishlists": "xyz789", "minimum_password_length": "xyz789", - "no_route": "abc123", - "payment_payflowpro_cc_vault_active": "abc123", - "printed_card_price": "xyz789", + "no_route": "xyz789", + "payment_payflowpro_cc_vault_active": "xyz789", + "printed_card_price": "abc123", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "abc123", - "product_url_suffix": "abc123", + "product_reviews_enabled": "xyz789", + "product_url_suffix": "xyz789", "required_character_classes_number": "abc123", "returns_enabled": "abc123", "root_category_id": 123, @@ -261,32 +261,32 @@ query availableStores($useCurrentGroup: Boolean) { "sales_gift_wrapping": "abc123", "sales_printed_card": "xyz789", "secure_base_link_url": "abc123", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, "show_cms_breadcrumbs": 987, "store_code": "4", "store_group_code": 4, - "store_group_name": "abc123", + "store_group_name": "xyz789", "store_name": "xyz789", - "store_sort_order": 987, - "timezone": "xyz789", + "store_sort_order": 123, + "timezone": "abc123", "title_prefix": "xyz789", "title_separator": "xyz789", "title_suffix": "xyz789", - "use_store_in_url": true, + "use_store_in_url": false, "website_code": 4, - "website_id": 987, + "website_id": 123, "website_name": "abc123", "weight_unit": "xyz789", "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, + "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_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 987, + "zero_subtotal_sort_order": 123, "zero_subtotal_title": "xyz789" } ] @@ -389,18 +389,18 @@ query cart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, + "id": 4, + "is_virtual": false, "items": [CartItemInterface], "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -549,7 +549,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -558,41 +558,41 @@ query category($id: Int) { { "data": { "category": { - "automatic_sorting": "xyz789", + "automatic_sorting": "abc123", "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", + "canonical_url": "abc123", "children": [CategoryTree], - "children_count": "xyz789", + "children_count": "abc123", "cms_block": CmsBlock, "created_at": "xyz789", - "custom_layout_update_file": "abc123", + "custom_layout_update_file": "xyz789", "default_sort_by": "abc123", "description": "xyz789", - "display_mode": "xyz789", + "display_mode": "abc123", "filter_price_range": 987.65, "id": 123, - "image": "xyz789", + "image": "abc123", "include_in_menu": 987, "is_anchor": 123, - "landing_page": 987, + "landing_page": 123, "level": 123, "meta_description": "xyz789", "meta_keywords": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "abc123", "path": "xyz789", - "path_in_store": "abc123", - "position": 123, + "path_in_store": "xyz789", + "position": 987, "product_count": 123, "products": CategoryProducts, - "redirect_code": 987, - "relative_url": "abc123", - "staged": true, + "redirect_code": 123, + "relative_url": "xyz789", + "staged": false, "type": "CMS_PAGE", "uid": "4", "updated_at": "xyz789", - "url_key": "xyz789", + "url_key": "abc123", "url_path": "abc123", "url_suffix": "abc123" } @@ -702,18 +702,18 @@ query categoryList( "categoryList": [ { "automatic_sorting": "abc123", - "available_sort_by": ["abc123"], + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], "canonical_url": "abc123", "children": [CategoryTree], "children_count": "abc123", "cms_block": CmsBlock, - "created_at": "abc123", + "created_at": "xyz789", "custom_layout_update_file": "xyz789", "default_sort_by": "abc123", "description": "abc123", "display_mode": "abc123", - "filter_price_range": 987.65, + "filter_price_range": 123.45, "id": 123, "image": "xyz789", "include_in_menu": 987, @@ -721,19 +721,19 @@ query categoryList( "landing_page": 987, "level": 987, "meta_description": "xyz789", - "meta_keywords": "xyz789", + "meta_keywords": "abc123", "meta_title": "abc123", - "name": "xyz789", - "path": "abc123", + "name": "abc123", + "path": "xyz789", "path_in_store": "xyz789", - "position": 987, + "position": 123, "product_count": 987, "products": CategoryProducts, "redirect_code": 123, "relative_url": "xyz789", "staged": true, "type": "CMS_PAGE", - "uid": "4", + "uid": 4, "updated_at": "abc123", "url_key": "abc123", "url_path": "xyz789", @@ -777,9 +777,9 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 987, - "checkbox_text": "abc123", - "content": "xyz789", + "agreement_id": 123, + "checkbox_text": "xyz789", + "content": "abc123", "content_height": "xyz789", "is_html": false, "mode": "AUTO", @@ -821,7 +821,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["abc123"]} +{"identifiers": ["xyz789"]} ``` ##### Response @@ -877,7 +877,7 @@ query cmsPage( ##### Variables ```json -{"id": 987, "identifier": "abc123"} +{"id": 123, "identifier": "xyz789"} ``` ##### Response @@ -886,7 +886,7 @@ query cmsPage( { "data": { "cmsPage": { - "content": "abc123", + "content": "xyz789", "content_heading": "xyz789", "identifier": "abc123", "meta_description": "abc123", @@ -975,12 +975,12 @@ query company { "company_admin": Customer, "credit": CompanyCredit, "credit_history": CompanyCreditHistory, - "email": "xyz789", - "id": "4", + "email": "abc123", + "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "xyz789", + "legal_name": "abc123", "name": "xyz789", - "payment_methods": ["xyz789"], + "payment_methods": ["abc123"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -1043,7 +1043,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -1084,11 +1084,11 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", + "full_name_english": "xyz789", + "full_name_locale": "xyz789", + "id": "abc123", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } ] } @@ -1141,10 +1141,10 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "abc123", + "full_name_english": "abc123", + "full_name_locale": "xyz789", "id": "abc123", - "three_letter_abbreviation": "abc123", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" } } @@ -1187,12 +1187,12 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "abc123", - "base_currency_symbol": "xyz789", - "default_display_currecy_code": "abc123", - "default_display_currecy_symbol": "abc123", + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", + "default_display_currecy_code": "xyz789", + "default_display_currecy_symbol": "xyz789", "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] @@ -1358,22 +1358,22 @@ query customer { "addresses": [CustomerAddress], "allow_remote_shopping_assistance": true, "compare_list": CompareList, - "created_at": "abc123", - "date_of_birth": "abc123", + "created_at": "xyz789", + "date_of_birth": "xyz789", "default_billing": "abc123", "default_shipping": "abc123", "dob": "xyz789", "email": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 987, + "group_id": 123, "id": 123, - "is_subscribed": false, + "is_subscribed": true, "job_title": "abc123", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -1381,7 +1381,7 @@ query customer { "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1390,9 +1390,9 @@ query customer { "role": CompanyRole, "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "abc123", - "taxvat": "abc123", + "structure_id": 4, + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist": Wishlist, @@ -1490,11 +1490,11 @@ query customerCart { "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, - "is_virtual": false, + "id": "4", + "is_virtual": true, "items": [CartItemInterface], "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -1573,7 +1573,7 @@ query customerOrders { "customerOrders": { "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } } } @@ -1671,7 +1671,7 @@ query dynamicBlocks( "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -1765,7 +1765,7 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "mode": "TEST", "paypal_url": "xyz789", "secure_token": "abc123", - "secure_token_id": "xyz789" + "secure_token_id": "abc123" } } } @@ -1815,7 +1815,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "xyz789", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -1884,16 +1884,16 @@ query giftRegistry($giftRegistryUid: ID!) { "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "abc123", + "event_name": "xyz789", "items": [GiftRegistryItemInterface], "message": "xyz789", - "owner_name": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } } } @@ -1911,7 +1911,7 @@ Search for gift registries by specifying a registrant email address. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](#string) | The registrant's email. | #### Example @@ -1943,11 +1943,11 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "abc123", - "event_title": "xyz789", + "event_date": "xyz789", + "event_title": "abc123", "gift_registry_uid": "4", "location": "abc123", - "name": "xyz789", + "name": "abc123", "type": "abc123" } ] @@ -1999,12 +1999,12 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "xyz789", - "gift_registry_uid": "4", + "gift_registry_uid": 4, "location": "xyz789", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ] } @@ -2057,7 +2057,7 @@ query giftRegistryTypeSearch( ```json { "firstName": "xyz789", - "lastName": "abc123", + "lastName": "xyz789", "giftRegistryTypeUid": 4 } ``` @@ -2069,12 +2069,12 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "xyz789", - "gift_registry_uid": 4, - "location": "abc123", + "gift_registry_uid": "4", + "location": "xyz789", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ] } @@ -2115,7 +2115,7 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", + "label": "xyz789", "uid": "4" } ] @@ -2152,7 +2152,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2228,13 +2228,13 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} ``` @@ -2266,7 +2266,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2376,7 +2376,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -2391,7 +2391,7 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "email": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, @@ -2403,8 +2403,8 @@ query negotiableQuote($uid: ID!) { NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 987.65, - "uid": "4", + "total_quantity": 123.45, + "uid": 4, "updated_at": "abc123" } } @@ -2557,7 +2557,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -2699,7 +2699,7 @@ Return the full details for a specified product, category, or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -2727,8 +2727,8 @@ query route($url: String!) { { "data": { "route": { - "redirect_code": 987, - "relative_url": "xyz789", + "redirect_code": 123, + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -2879,122 +2879,122 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "xyz789", + "absolute_footer": "abc123", "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "abc123", "allow_items": "xyz789", "allow_order": "abc123", - "allow_printed_card": "xyz789", + "allow_printed_card": "abc123", "autocomplete_on_storefront": false, "base_currency_code": "xyz789", - "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "xyz789", - "base_url": "abc123", + "base_link_url": "abc123", + "base_media_url": "abc123", + "base_static_url": "abc123", + "base_url": "xyz789", "braintree_cc_vault_active": "abc123", - "cart_gift_wrapping": "xyz789", - "cart_printed_card": "abc123", + "cart_gift_wrapping": "abc123", + "cart_printed_card": "xyz789", "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_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": "abc123", + "check_money_order_new_order_status": "xyz789", "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_title": "xyz789", + "cms_home_page": "abc123", "cms_no_cookies": "abc123", "cms_no_route": "abc123", - "code": "xyz789", + "code": "abc123", "configurable_thumbnail_source": "xyz789", "copyright": "abc123", - "default_description": "xyz789", - "default_display_currency_code": "xyz789", + "default_description": "abc123", + "default_display_currency_code": "abc123", "default_keywords": "abc123", - "default_title": "xyz789", - "demonotice": 987, - "enable_multiple_wishlists": "xyz789", - "front": "xyz789", + "default_title": "abc123", + "demonotice": 123, + "enable_multiple_wishlists": "abc123", + "front": "abc123", "grid_per_page": 987, "grid_per_page_values": "abc123", "head_includes": "abc123", - "head_shortcut_icon": "xyz789", + "head_shortcut_icon": "abc123", "header_logo_src": "abc123", "id": 123, "is_default_store": false, - "is_default_store_group": false, - "is_negotiable_quote_active": false, + "is_default_store_group": true, + "is_negotiable_quote_active": true, "is_requisition_list_active": "abc123", - "list_mode": "abc123", - "list_per_page": 123, - "list_per_page_values": "xyz789", - "locale": "xyz789", + "list_mode": "xyz789", + "list_per_page": 987, + "list_per_page_values": "abc123", + "locale": "abc123", "logo_alt": "abc123", "logo_height": 123, "logo_width": 987, "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "xyz789", - "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": "abc123", - "magento_reward_points_order": "abc123", - "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "abc123", - "magento_reward_points_review_limit": "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": "abc123", - "maximum_number_of_wishlists": "abc123", + "maximum_number_of_wishlists": "xyz789", "minimum_password_length": "xyz789", - "no_route": "xyz789", + "no_route": "abc123", "payment_payflowpro_cc_vault_active": "xyz789", "printed_card_price": "xyz789", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "abc123", "product_url_suffix": "xyz789", "required_character_classes_number": "xyz789", - "returns_enabled": "xyz789", - "root_category_id": 123, - "root_category_uid": "4", + "returns_enabled": "abc123", + "root_category_id": 987, + "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", + "sales_gift_wrapping": "abc123", "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", - "secure_base_media_url": "xyz789", + "secure_base_link_url": "abc123", + "secure_base_media_url": "abc123", "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "show_cms_breadcrumbs": 123, + "show_cms_breadcrumbs": 987, "store_code": "4", "store_group_code": "4", "store_group_name": "xyz789", "store_name": "xyz789", "store_sort_order": 987, - "timezone": "xyz789", - "title_prefix": "xyz789", + "timezone": "abc123", + "title_prefix": "abc123", "title_separator": "abc123", - "title_suffix": "xyz789", + "title_suffix": "abc123", "use_store_in_url": false, - "website_code": "4", - "website_id": 987, + "website_code": 4, + "website_id": 123, "website_name": "abc123", "weight_unit": "xyz789", - "welcome": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, + "welcome": "abc123", + "zero_subtotal_enable_for_specific_countries": false, "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_payment_action": "xyz789", + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } } @@ -3017,7 +3017,7 @@ Return the relative URL for a specified product, category or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3048,10 +3048,10 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "xyz789", - "entity_uid": "4", - "id": 987, - "redirectCode": 123, + "canonical_url": "abc123", + "entity_uid": 4, + "id": 123, + "redirectCode": 987, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -3097,8 +3097,8 @@ query wishlist { "wishlist": { "items": [WishlistItem], "items_count": 987, - "name": "xyz789", - "sharing_code": "xyz789", + "name": "abc123", + "sharing_code": "abc123", "updated_at": "abc123" } } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-2.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-2.md deleted file mode 100644 index f8e73e970..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-2.md +++ /dev/null @@ -1,6128 +0,0 @@ -### CustomizableFileOption - -Contains information about a file picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | - -#### Example - -```json -{ - "option_id": 123, - "product_sku": "xyz789", - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": CustomizableFileValue -} -``` - - - -### CustomizableFileValue - -Defines the price and sku of a product whose page contains a customized file picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `file_extension` - [`String`](#string) | The file extension to accept. | -| `image_size_x` - [`Int`](#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](#int) | The maximum height of an image. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | - -#### Example - -```json -{ - "file_extension": "xyz789", - "image_size_x": 123, - "image_size_y": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableMultipleOption - -Contains information about a multiselect that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": 4, - "value": [CustomizableMultipleValue] -} -``` - - - -### CustomizableMultipleValue - -Defines the price and sku of a product whose page contains a customized multiselect. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableOptionInput - -Defines a customizable option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`Int`](#int) | The customizable option ID of the product. | -| `value_string` - [`String!`](#string) | The string value of the option. | - -#### Example - -```json -{"id": 987, "value_string": "xyz789"} -``` - - - -### CustomizableOptionInterface - -Contains basic information about a customizable option. It can be implemented by several types of configurable options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | - -#### Possible Types - -| CustomizableOptionInterface Types | -|----------------| -| [`CustomizableAreaOption`](#customizableareaoption) | -| [`CustomizableDateOption`](#customizabledateoption) | -| [`CustomizableDropDownOption`](#customizabledropdownoption) | -| [`CustomizableMultipleOption`](#customizablemultipleoption) | -| [`CustomizableFieldOption`](#customizablefieldoption) | -| [`CustomizableFileOption`](#customizablefileoption) | -| [`CustomizableRadioOption`](#customizableradiooption) | -| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### CustomizableProductInterface - -Contains information about customizable product options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | - -#### Possible Types - -| CustomizableProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`ConfigurableProduct`](#configurableproduct) | - -#### Example - -```json -{"options": [CustomizableOptionInterface]} -``` - - - -### CustomizableRadioOption - -Contains information about a set of radio buttons that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": [CustomizableRadioValue] -} -``` - - - -### CustomizableRadioValue - -Defines the price and sku of a product whose page contains a customized set of radio buttons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, - "title": "abc123", - "uid": 4 -} -``` - - - -### DeleteCompanyRoleOutput - -Contains the response to the request to delete the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyTeamOutput - -Contains the status of the request to delete a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyUserOutput - -Contains the response to the request to delete the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompareListOutput - -Contains the results of the request to delete a compare list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | - -#### Example - -```json -{"result": true} -``` - - - -### DeleteNegotiableQuoteError - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | - -#### Example - -```json -NegotiableQuoteInvalidStateError -``` - - - -### DeleteNegotiableQuoteOperationFailure - -Contains details about a failed delete operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 -} -``` - - - -### DeleteNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | - -#### Example - -```json -NegotiableQuoteUidOperationSuccess -``` - - - -### DeleteNegotiableQuotesInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | - -#### Example - -```json -{"quote_uids": [4]} -``` - - - -### DeleteNegotiableQuotesOutput - -Contains a list of undeleted negotiable quotes the company user can view. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | -| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | - -#### Example - -```json -{ - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} -``` - - - -### DeletePaymentTokenOutput - -Indicates whether the request succeeded and returns the remaining customer payment tokens. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | - -#### Example - -```json -{ - "customerPaymentTokens": CustomerPaymentTokens, - "result": true -} -``` - - - -### DeletePurchaseOrderApprovalRuleError - -Contains details about an error that occurred when deleting an approval rule . - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | -| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | - -#### Example - -```json -{"message": "xyz789", "type": "UNDEFINED"} -``` - - - -### DeletePurchaseOrderApprovalRuleErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `NOT_FOUND` | | - -#### Example - -```json -""UNDEFINED"" -``` - - - -### DeletePurchaseOrderApprovalRuleInput - -Specifies the IDs of the approval rules to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | - -#### Example - -```json -{"approval_rule_uids": [4]} -``` - - - -### DeletePurchaseOrderApprovalRuleOutput - -Contains any errors encountered while attempting to delete approval rules. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | - -#### Example - -```json -{"errors": [DeletePurchaseOrderApprovalRuleError]} -``` - - - -### DeleteRequisitionListItemsOutput - -Output of the request to remove items from the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### DeleteRequisitionListOutput - -Indicates whether the request to delete the requisition list was successful. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | - -#### Example - -```json -{"requisition_lists": RequisitionLists, "status": false} -``` - - - -### DeleteWishlistOutput - -Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | - -#### Example - -```json -{"status": false, "wishlists": [Wishlist]} -``` - - - -### Discount - -Defines an individual discount. A discount can be applied to the cart as a whole or to an item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | -| `label` - [`String!`](#string) | A description of the discount. | - -#### Example - -```json -{ - "amount": Money, - "label": "xyz789" -} -``` - - - -### DownloadableCartItem - -An implementation for downloadable product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "errors": [CartItemError], - "id": "xyz789", - "links": [DownloadableProductLinks], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples], - "uid": "4" -} -``` - - - -### DownloadableCreditMemoItem - -Defines downloadable product options for `CreditMemoItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 -} -``` - - - -### DownloadableFileTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | - -#### Example - -```json -""FILE"" -``` - - - -### DownloadableInvoiceItem - -Defines downloadable product options for `InvoiceItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### DownloadableItemsLinks - -Defines characteristics of the links for downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | - -#### Example - -```json -{ - "sort_order": 987, - "title": "xyz789", - "uid": "4" -} -``` - - - -### DownloadableOrderItem - -Defines downloadable product options for `OrderItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### DownloadableProduct - -Defines a product that the shopper downloads. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | -| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "abc123", - "collar": "xyz789", - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "downloadable_product_links": [ - DownloadableProductLinks - ], - "downloadable_product_samples": [ - DownloadableProductSamples - ], - "eco_collection": 123, - "erin_recommends": 987, - "features_bags": "xyz789", - "format": 123, - "gender": "xyz789", - "gift_message_available": "xyz789", - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "links_purchased_separately": 123, - "links_title": "xyz789", - "manufacturer": 123, - "material": "xyz789", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "name": "xyz789", - "new": 987, - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 123, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 987, - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 987, - "reviews": ProductReviews, - "sale": 987, - "short_description": ComplexTextValue, - "size": 123, - "sku": "xyz789", - "sleeve": "abc123", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "abc123", - "staged": true, - "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "abc123", - "style_bottom": "abc123", - "style_general": "xyz789", - "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": "xyz789", - "websites": [Website] -} -``` - - - -### DownloadableProductCartItemInput - -Defines a single downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | -| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "downloadable_product_links": [ - DownloadableProductLinksInput - ] -} -``` - - - -### DownloadableProductLinks - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | -| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](#float) | The price of the downloadable product. | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | - -#### Example - -```json -{ - "id": 987, - "is_shareable": true, - "link_type": "FILE", - "number_of_downloads": 987, - "price": 123.45, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "abc123", - "sort_order": 123, - "title": "abc123", - "uid": 4 -} -``` - - - -### DownloadableProductLinksInput - -Contains the link ID for the downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | - -#### Example - -```json -{"link_id": 987} -``` - - - -### DownloadableProductSamples - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the sample. | - -#### Example - -```json -{ - "id": 987, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "abc123", - "sort_order": 123, - "title": "abc123" -} -``` - - - -### DownloadableRequisitionListItem - -Contains details about downloadable products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "links": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 987.65, - "samples": [DownloadableProductSamples], - "uid": "4" -} -``` - - - -### DownloadableWishlistItem - -A downloadable product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "links_v2": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples] -} -``` - - - -### DynamicBlock - -Contains a single dynamic block. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | - -#### Example - -```json -{ - "content": ComplexTextValue, - "uid": "4" -} -``` - - - -### DynamicBlockLocationEnum - -Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CONTENT` | | -| `HEADER` | | -| `FOOTER` | | -| `LEFT` | | -| `RIGHT` | | - -#### Example - -```json -""CONTENT"" -``` - - - -### DynamicBlockTypeEnum - -Indicates the selected Dynamic Blocks Rotator inline widget. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SPECIFIED` | | -| `CART_PRICE_RULE_RELATED` | | -| `CATALOG_PRICE_RULE_RELATED` | | - -#### Example - -```json -""SPECIFIED"" -``` - - - -### DynamicBlocks - -Contains an array of dynamic blocks. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | - -#### Example - -```json -{ - "items": [DynamicBlock], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### DynamicBlocksFilterInput - -Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | -| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | -| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | - -#### Example - -```json -{ - "dynamic_block_uids": ["4"], - "locations": ["CONTENT"], - "type": "SPECIFIED" -} -``` - - - -### EnteredCustomAttributeInput - -Contains details about a custom text attribute that the buyer entered. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "abc123" -} -``` - - - -### EnteredOptionInput - -Defines a customer-entered option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](#string) | Text the customer entered. | - -#### Example - -```json -{ - "uid": "4", - "value": "xyz789" -} -``` - - - -### EntityUrl - -Contains the `uid`, `relative_url`, and `type` attributes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | -| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Example - -```json -{ - "canonical_url": "abc123", - "entity_uid": 4, - "id": 123, - "redirectCode": 123, - "relative_url": "abc123", - "type": "CMS_PAGE" -} -``` - - - -### ErrorInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Possible Types - -| ErrorInterface Types | -|----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### ExchangeRate - -Lists the exchange rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | - -#### Example - -```json -{"currency_to": "xyz789", "rate": 987.65} -``` - - - -### FilterEqualTypeInput - -Defines a filter that matches the input exactly. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#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]`](#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 - -```json -{ - "eq": "xyz789", - "in": ["xyz789"] -} -``` - - - -### FilterMatchTypeInput - -Defines a filter that performs a fuzzy search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `match` - [`String`](#string) | Use this attribute to exactly match the specified string. For example, to filter on a specific SKU, specify a value such as `24-MB01`. | - -#### Example - -```json -{"match": "abc123"} -``` - - - -### FilterRangeTypeInput - -Defines a filter that matches a range of values, such as prices or dates. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | - -#### Example - -```json -{ - "from": "xyz789", - "to": "xyz789" -} -``` - - - -### FilterStringTypeInput - -Defines a filter for an input string. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | - -#### Example - -```json -{ - "eq": "abc123", - "in": ["xyz789"], - "match": "abc123" -} -``` - - - -### FilterTypeInput - -Defines the comparison operators that can be used in a filter. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Equals. | -| `finset` - [`[String]`](#string) | | -| `from` - [`String`](#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](#string) | Greater than. | -| `gteq` - [`String`](#string) | Greater than or equal to. | -| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](#string) | Less than. | -| `lteq` - [`String`](#string) | Less than or equal to. | -| `moreq` - [`String`](#string) | More than or equal to. | -| `neq` - [`String`](#string) | Not equal to. | -| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](#string) | Not null. | -| `null` - [`String`](#string) | Is null. | -| `to` - [`String`](#string) | To. Must be used with the `from` field. | - -#### Example - -```json -{ - "eq": "abc123", - "finset": ["xyz789"], - "from": "xyz789", - "gt": "xyz789", - "gteq": "xyz789", - "in": ["xyz789"], - "like": "xyz789", - "lt": "xyz789", - "lteq": "xyz789", - "moreq": "abc123", - "neq": "xyz789", - "nin": ["abc123"], - "notnull": "xyz789", - "null": "abc123", - "to": "abc123" -} -``` - - - -### FixedProductTax - -A single FPT that can be applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | - -#### Example - -```json -{ - "amount": Money, - "label": "abc123" -} -``` - - - -### FixedProductTaxDisplaySettings - -Lists display settings for the Fixed Product Tax. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""INCLUDE_FPT_WITHOUT_DETAILS"" -``` - - - -### Float - -The `Float` scalar type represents signed double-precision fractional -values as specified by -[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -#### Example - -```json -123.45 -``` - - - -### GenerateCustomerTokenAsAdminInput - -Identifies which customer requires remote shopping assistance. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | - -#### Example - -```json -{"customer_email": "xyz789"} -``` - - - -### GenerateCustomerTokenAsAdminOutput - -Contains the generated customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | - -#### Example - -```json -{"customer_token": "xyz789"} -``` - - - -### GiftCardAccount - -Contains details about the gift card account. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`Money`](#money) | The balance remaining on the gift card. | -| `code` - [`String`](#string) | The gift card account code. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | - -#### Example - -```json -{ - "balance": Money, - "code": "xyz789", - "expiration_date": "abc123" -} -``` - - - -### GiftCardAccountInput - -Contains the gift card code. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | - -#### Example - -```json -{"gift_card_code": "abc123"} -``` - - - -### GiftCardAmounts - -Contains the value of a gift card, the website that generated the card, and related information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_id` - [`Int`](#int) | An internal attribute ID. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | -| `value` - [`Float`](#float) | The value of the gift card. | -| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | -| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | -| `website_value` - [`Float`](#float) | The value of the gift card. | - -#### Example - -```json -{ - "attribute_id": 987, - "uid": "4", - "value": 987.65, - "value_id": 987, - "website_id": 123, - "website_value": 123.45 -} -``` - - - -### GiftCardCartItem - -Contains details about a gift card that has been added to a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender. | -| `sender_name` - [`String!`](#string) | The name of the sender. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "amount": Money, - "customizable_options": [SelectedCustomizableOption], - "errors": [CartItemError], - "id": "abc123", - "message": "abc123", - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "xyz789", - "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "xyz789", - "uid": 4 -} -``` - - - -### GiftCardCreditMemoItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 -} -``` - - - -### GiftCardInvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### GiftCardItem - -Contains details about a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | - -#### Example - -```json -{ - "message": "xyz789", - "recipient_email": "abc123", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "abc123" -} -``` - - - -### GiftCardOptions - -Contains details about the sender, recipient, and amount of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](#string) | A message to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | - -#### Example - -```json -{ - "amount": Money, - "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "abc123" -} -``` - - - -### GiftCardOrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "eligible_for_return": true, - "entered_options": [OrderItemOption], - "gift_card": GiftCardItem, - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "4", - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 123.45, - "quantity_returned": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "abc123" -} -``` - - - -### GiftCardProduct - -Defines properties of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | -| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | -| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "activity": "abc123", - "allow_message": true, - "allow_open_amount": false, - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "collar": "xyz789", - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 987, - "features_bags": "abc123", - "format": 987, - "gender": "xyz789", - "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": "abc123", - "giftcard_amounts": [GiftCardAmounts], - "giftcard_type": "VIRTUAL", - "id": 987, - "image": ProductImage, - "is_redeemable": true, - "is_returnable": "abc123", - "lifetime": 123, - "manufacturer": 987, - "material": "abc123", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 987, - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", - "name": "xyz789", - "new": 123, - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "open_amount_max": 987.65, - "open_amount_min": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 123, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 987, - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "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": "xyz789", - "staged": false, - "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "xyz789", - "style_bottom": "xyz789", - "style_general": "xyz789", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "tier_price": 123.45, - "tier_prices": [ProductTierPrices], - "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": "4", - "updated_at": "xyz789", - "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 987.65 -} -``` - - - -### GiftCardRequisitionListItem - -Contains details about gift cards added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "gift_card_options": GiftCardOptions, - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" -} -``` - - - -### GiftCardShipmentItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Example - -```json -{ - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 123.45 -} -``` - - - -### GiftCardTypeEnum - -Specifies the gift card type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `VIRTUAL` | | -| `PHYSICAL` | | -| `COMBINED` | | - -#### Example - -```json -""VIRTUAL"" -``` - - - -### GiftCardWishlistItem - -A single gift card added to a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "gift_card_options": GiftCardOptions, - "id": 4, - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### GiftMessage - -Contains the text of a gift message, its sender, and recipient - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | - -#### Example - -```json -{ - "from": "xyz789", - "message": "xyz789", - "to": "xyz789" -} -``` - - - -### GiftMessageInput - -Defines a gift message. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String!`](#string) | The name of the sender. | -| `message` - [`String!`](#string) | The text of the gift message. | -| `to` - [`String!`](#string) | The name of the recepient. | - -#### Example - -```json -{ - "from": "xyz789", - "message": "abc123", - "to": "xyz789" -} -``` - - - -### GiftOptionsPrices - -Contains prices for gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | -| `printed_card` - [`Money`](#money) | Price for the printed card. | - -#### Example - -```json -{ - "gift_wrapping_for_items": Money, - "gift_wrapping_for_order": Money, - "printed_card": Money -} -``` - - - -### GiftRegistry - -Contains details about a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | -| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | -| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | -| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | -| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | - -#### Example - -```json -{ - "created_at": "abc123", - "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" -} -``` - - - -### GiftRegistryDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": "4", - "group": "EVENT_INFORMATION", - "label": "abc123", - "value": "xyz789" -} -``` - - - -### GiftRegistryDynamicAttributeGroup - -Defines the group type of a gift registry dynamic attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `EVENT_INFORMATION` | | -| `PRIVACY_SETTINGS` | | -| `REGISTRANT` | | -| `GENERAL_INFORMATION` | | -| `DETAILED_INFORMATION` | | -| `SHIPPING_ADDRESS` | | - -#### Example - -```json -""EVENT_INFORMATION"" -``` - - - -### GiftRegistryDynamicAttributeInput - -Defines a dynamic attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | - -#### Example - -```json -{"code": 4, "value": "abc123"} -``` - - - -### GiftRegistryDynamicAttributeInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Possible Types - -| GiftRegistryDynamicAttributeInterface Types | -|----------------| -| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | -| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | - -#### Example - -```json -{ - "code": "4", - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeMetadata - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Example - -```json -{ - "attribute_group": "xyz789", - "code": "4", - "input_type": "xyz789", - "is_required": true, - "label": "xyz789", - "sort_order": 123 -} -``` - - - -### GiftRegistryDynamicAttributeMetadataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Possible Types - -| GiftRegistryDynamicAttributeMetadataInterface Types | -|----------------| -| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | - -#### Example - -```json -{ - "attribute_group": "abc123", - "code": "4", - "input_type": "abc123", - "is_required": false, - "label": "xyz789", - "sort_order": 123 -} -``` - - - -### GiftRegistryItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "abc123", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 123.45, - "uid": "4" -} -``` - - - -### GiftRegistryItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Possible Types - -| GiftRegistryItemInterface Types | -|----------------| -| [`GiftRegistryItem`](#giftregistryitem) | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "abc123", - "product": ProductInterface, - "quantity": 987.65, - "quantity_fulfilled": 123.45, - "uid": 4 -} -``` - - - -### GiftRegistryItemUserErrorInterface - -Contains the status and any errors that encountered with the customer's gift register item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Possible Types - -| GiftRegistryItemUserErrorInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{ - "status": false, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### GiftRegistryItemsUserError - -Contains details about an error that occurred when processing a gift registry item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | -| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | -| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | -| `message` - [`String!`](#string) | A localized error message. | -| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | - -#### Example - -```json -{ - "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": "4", - "message": "xyz789", - "product_uid": 4 -} -``` - - - -### GiftRegistryItemsUserErrorType - -Defines the error type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""OUT_OF_STOCK"" -``` - - - -### GiftRegistryOutputInterface - -Contains the customer's gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | - -#### Possible Types - -| GiftRegistryOutputInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### GiftRegistryPrivacySettings - -Defines the privacy setting of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRIVATE` | | -| `PUBLIC` | | - -#### Example - -```json -""PRIVATE"" -``` - - - -### GiftRegistryRegistrant - -Contains details about a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryRegistrantDynamicAttribute - ], - "email": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "uid": 4 -} -``` - - - -### GiftRegistryRegistrantDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": 4, - "label": "abc123", - "value": "abc123" -} -``` - - - -### GiftRegistrySearchResult - -Contains the results of a gift registry search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | -| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](#string) | The location of the event. | -| `name` - [`String!`](#string) | The name of the gift registry owner. | -| `type` - [`String`](#string) | The type of event being held. | - -#### Example - -```json -{ - "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "xyz789", - "name": "xyz789", - "type": "abc123" -} -``` - - - -### GiftRegistryShippingAddressInput - -Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | -| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | - -#### Example - -```json -{ - "address_data": CustomerAddressInput, - "address_id": "4" -} -``` - - - -### GiftRegistryStatus - -Defines the status of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ACTIVE` | | -| `INACTIVE` | | - -#### Example - -```json -""ACTIVE"" -``` - - - -### GiftRegistryType - -Contains details about a gift registry type. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | - -#### Example - -```json -{ - "dynamic_attributes_metadata": [ - GiftRegistryDynamicAttributeMetadataInterface - ], - "label": "xyz789", - "uid": "4" -} -``` - - - -### GiftWrapping - -Contains details about the selected or available gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | -| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | -| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | -| `price` - [`Money!`](#money) | The gift wrapping price. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | - -#### Example - -```json -{ - "design": "xyz789", - "id": 4, - "image": GiftWrappingImage, - "price": Money, - "uid": 4 -} -``` - - - -### GiftWrappingImage - -Points to an image associated with a gift wrapping option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | - -#### Example - -```json -{ - "label": "abc123", - "url": "xyz789" -} -``` - - - -### GroupedProduct - -Defines a grouped product, which consists of simple standalone products that are presented as a group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "activity": "abc123", - "attribute_set_id": 987, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "abc123", - "collar": "xyz789", - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 123, - "features_bags": "abc123", - "format": 987, - "gender": "xyz789", - "gift_message_available": "xyz789", - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "items": [GroupedProductItem], - "manufacturer": 987, - "material": "xyz789", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "xyz789", - "new": 123, - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options_container": "xyz789", - "pattern": "xyz789", - "performance_fabric": 123, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 123, - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, - "reviews": ProductReviews, - "sale": 123, - "short_description": ComplexTextValue, - "size": 123, - "sku": "abc123", - "sleeve": "abc123", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "abc123", - "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": "abc123", - "uid": "4", - "updated_at": "abc123", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 123.45 -} -``` - - - -### GroupedProductItem - -Contains information about an individual grouped product item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | -| `qty` - [`Float`](#float) | The quantity of this grouped product item. | - -#### Example - -```json -{ - "position": 987, - "product": ProductInterface, - "qty": 987.65 -} -``` - - - -### GroupedProductWishlistItem - -A grouped product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### HostedProInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "return_url": "abc123" -} -``` - - - -### HostedProUrl - -Contains the secure URL used for the Payments Pro Hosted Solution payment method. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | - -#### Example - -```json -{"secure_form_url": "xyz789"} -``` - - - -### HostedProUrlInput - -Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### HttpQueryParameter - -Contains target path parameters. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "abc123" -} -``` - - - -### ID - -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 - -```json -4 -``` - - - -### ImageSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{ - "thumbnail": "abc123", - "value": "xyz789" -} -``` - - - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. - -#### Example - -```json -987 -``` - - - -### InternalError - -Contains an error message when an internal error occurred. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### Invoice - -Contains invoice details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | -| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | -| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](#string) | Sequential invoice number. | -| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": 4, - "items": [InvoiceItemInterface], - "number": "abc123", - "total": InvoiceTotal -} -``` - - - -### InvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 -} -``` - - - -### InvoiceItemInterface - -Contains detailes about invoiced items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Possible Types - -| InvoiceItemInterface Types | -|----------------| -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | -| [`InvoiceItem`](#invoiceitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 -} -``` - - - -### InvoiceTotal - -Contains price details from an invoice. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### IsCompanyAdminEmailAvailableOutput - -Contains the response of a company admin email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsCompanyEmailAvailableOutput - -Contains the response of a company email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsCompanyRoleNameAvailableOutput - -Contains the response of a role name validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | - -#### Example - -```json -{"is_role_name_available": false} -``` - - - -### IsCompanyUserEmailAvailableOutput - -Contains the response of a company user email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsEmailAvailableOutput - -Contains the result of the `isEmailAvailable` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### ItemSelectedBundleOption - -A list of options of the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](#string) | The label of the option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | -| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | - -#### Example - -```json -{ - "id": "4", - "label": "xyz789", - "uid": 4, - "values": [ItemSelectedBundleOptionValue] -} -``` - - - -### ItemSelectedBundleOptionValue - -A list of values for the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](#money) | The price of the child bundle product. | -| `product_name` - [`String!`](#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | -| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | - -#### Example - -```json -{ - "id": "4", - "price": Money, - "product_name": "abc123", - "product_sku": "abc123", - "quantity": 123.45, - "uid": 4 -} -``` - - - -### KeyValue - -Contains a key-value pair. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name part of the key/value pair. | -| `value` - [`String`](#string) | The value part of the key/value pair. | - -#### Example - -```json -{ - "name": "abc123", - "value": "xyz789" -} -``` - - - -### LayerFilter - -Contains information for rendering layered navigation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | - -#### Example - -```json -{ - "filter_items": [LayerFilterItemInterface], - "filter_items_count": 123, - "name": "abc123", - "request_var": "abc123" -} -``` - - - -### LayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 123, - "label": "abc123", - "value_string": "xyz789" -} -``` - - - -### LayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Possible Types - -| LayerFilterItemInterface Types | -|----------------| -| [`LayerFilterItem`](#layerfilteritem) | -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{ - "items_count": 987, - "label": "abc123", - "value_string": "xyz789" -} -``` - - - -### MediaGalleryEntry - -Defines characteristics about images and videos associated with a specific product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](#string) | The path of the image on the server. | -| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](#string) | Either `image` or `video`. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | - -#### Example - -```json -{ - "content": ProductMediaGalleryEntriesContent, - "disabled": false, - "file": "xyz789", - "id": 123, - "label": "xyz789", - "media_type": "abc123", - "position": 987, - "types": ["abc123"], - "uid": "4", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### MediaGalleryInterface - -Contains basic information about a product image or video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Possible Types - -| MediaGalleryInterface Types | -|----------------| -| [`ProductImage`](#productimage) | -| [`ProductVideo`](#productvideo) | - -#### Example - -```json -{ - "disabled": true, - "label": "abc123", - "position": 123, - "url": "xyz789" -} -``` - - - -### Money - -Defines a monetary value, including a numeric value and a currency code. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](#float) | A number expressing a monetary value. | - -#### Example - -```json -{"currency": "AFN", "value": 123.45} -``` - - - -### MoveCartItemsToGiftRegistryOutput - -Contains the customer's gift registry and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Example - -```json -{ - "gift_registry": GiftRegistry, - "status": false, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### MoveItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be moved. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | - -#### Example - -```json -{"requisitionListItemUids": [4]} -``` - - - -### MoveItemsBetweenRequisitionListsOutput - -Output of the request to move items to another requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | - -#### Example - -```json -{ - "destination_requisition_list": RequisitionList, - "source_requisition_list": RequisitionList -} -``` - - - -### MoveProductsBetweenWishlistsOutput - -Contains the source and target wish lists after moving products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | - -#### Example - -```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} -``` - - - -### NegotiableQuote - -Contains details about a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | -| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](#string) | The email address of the company user. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | -| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | - -#### Example - -```json -{ - "available_payment_methods": [AvailablePaymentMethod], - "billing_address": NegotiableQuoteBillingAddress, - "buyer": NegotiableQuoteUser, - "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "xyz789", - "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, - "items": [CartItemInterface], - "name": "abc123", - "prices": CartPrices, - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "SUBMITTED", - "total_quantity": 123.45, - "uid": 4, - "updated_at": "abc123" -} -``` - - - -### NegotiableQuoteAddressCountry - -Defines the company's country. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | - -#### Example - -```json -{ - "code": "xyz789", - "label": "abc123" -} -``` - - - -### NegotiableQuoteAddressInput - -Defines the billing or shipping address to be applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company name. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | - -#### Example - -```json -{ - "city": "abc123", - "company": "xyz789", - "country_code": "abc123", - "firstname": "xyz789", - "lastname": "abc123", - "postcode": "abc123", - "region": "xyz789", - "region_id": 123, - "save_in_address_book": false, - "street": ["xyz789"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteAddressInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Possible Types - -| NegotiableQuoteAddressInterface Types | -|----------------| -| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | -| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "abc123" -} -``` - - - -### NegotiableQuoteAddressRegion - -Defines the company's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The address region code. | -| `label` - [`String`](#string) | The display name of the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "code": "abc123", - "label": "xyz789", - "region_id": 123 -} -``` - - - -### NegotiableQuoteBillingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "abc123", - "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteBillingAddressInput - -Defines the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "same_as_shipping": false, - "use_for_shipping": true -} -``` - - - -### NegotiableQuoteComment - -Contains a single plain text comment from either the buyer or seller. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | -| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](#string) | The plain text comment. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | - -#### Example - -```json -{ - "author": NegotiableQuoteUser, - "created_at": "xyz789", - "creator_type": "BUYER", - "text": "abc123", - "uid": "4" -} -``` - - - -### NegotiableQuoteCommentCreatorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BUYER` | | -| `SELLER` | | - -#### Example - -```json -""BUYER"" -``` - - - -### NegotiableQuoteCommentInput - -Contains the commend provided by the buyer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | - -#### Example - -```json -{"comment": "xyz789"} -``` - - - -### NegotiableQuoteCustomLogChange - -Contains custom log entries added by third-party extensions. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_value` - [`String!`](#string) | The new entry content. | -| `old_value` - [`String`](#string) | The previous entry in the custom log. | -| `title` - [`String!`](#string) | The title of the custom log entry. | - -#### Example - -```json -{ - "new_value": "xyz789", - "old_value": "abc123", - "title": "xyz789" -} -``` - - - -### NegotiableQuoteFilterInput - -Defines a filter to limit the negotiable quotes to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | - -#### Example - -```json -{ - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput -} -``` - - - -### NegotiableQuoteHistoryChanges - -Contains a list of changes to a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | - -#### Example - -```json -{ - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange -} -``` - - - -### NegotiableQuoteHistoryCommentChange - -Contains a comment submitted by a seller or buyer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | - -#### Example - -```json -{"comment": "abc123"} -``` - - - -### NegotiableQuoteHistoryEntry - -Contains details about a change for a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | -| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | -| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | - -#### Example - -```json -{ - "author": NegotiableQuoteUser, - "change_type": "CREATED", - "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", - "uid": "4" -} -``` - - - -### NegotiableQuoteHistoryEntryChangeType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CREATED` | | -| `UPDATED` | | -| `CLOSED` | | -| `UPDATED_BY_SYSTEM` | | - -#### Example - -```json -""CREATED"" -``` - - - -### NegotiableQuoteHistoryExpirationChange - -Contains a new expiration date and the previous date. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | - -#### Example - -```json -{ - "new_expiration": "xyz789", - "old_expiration": "abc123" -} -``` - - - -### NegotiableQuoteHistoryProductsRemovedChange - -Contains lists of products that have been removed from the catalog and negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | -| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | - -#### Example - -```json -{ - "products_removed_from_catalog": [4], - "products_removed_from_quote": [ProductInterface] -} -``` - - - -### NegotiableQuoteHistoryStatusChange - -Lists a new status change applied to a negotiable quote and the previous status. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | -| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | - -#### Example - -```json -{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} -``` - - - -### NegotiableQuoteHistoryStatusesChange - -Contains a list of status changes that occurred for the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | - -#### Example - -```json -{"changes": [NegotiableQuoteHistoryStatusChange]} -``` - - - -### NegotiableQuoteHistoryTotalChange - -Contains a new price and the previous price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_price` - [`Money`](#money) | The total price as a result of the change. | -| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | - -#### Example - -```json -{ - "new_price": Money, - "old_price": Money -} -``` - - - -### NegotiableQuoteInvalidStateError - -An error indicating that an operation was attempted on a negotiable quote in an invalid state. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### NegotiableQuoteItemQuantityInput - -Specifies the updated quantity of an item. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | - -#### Example - -```json -{"quantity": 987.65, "quote_item_uid": 4} -``` - - - -### NegotiableQuotePaymentMethodInput - -Defines the payment method to be applied to the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | - -#### Example - -```json -{ - "code": "xyz789", - "purchase_order_number": "abc123" -} -``` - - - -### NegotiableQuoteShippingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Example - -```json -{ - "available_shipping_methods": [AvailableShippingMethod], - "city": "xyz789", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "abc123", - "region": NegotiableQuoteAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteShippingAddressInput - -Defines shipping addresses for the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "abc123" -} -``` - - - -### NegotiableQuoteSortInput - -Defines the field to use to sort a list of negotiable quotes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} -``` - - - -### NegotiableQuoteSortableField - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""QUOTE_NAME"" -``` - - - -### NegotiableQuoteStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SUBMITTED` | | -| `PENDING` | | -| `UPDATED` | | -| `OPEN` | | -| `ORDERED` | | -| `CLOSED` | | -| `DECLINED` | | -| `EXPIRED` | | - -#### Example - -```json -""SUBMITTED"" -``` - - - -### NegotiableQuoteUidNonFatalResultInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Possible Types - -| NegotiableQuoteUidNonFatalResultInterface Types | -|----------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | - -#### Example - -```json -{"quote_uid": "4"} -``` - - - -### NegotiableQuoteUidOperationSuccess - -Contains details about a successful operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### NegotiableQuoteUser - -A limited view of a Buyer or Seller in the negotiable quote process. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | - -#### Example - -```json -{ - "firstname": "abc123", - "lastname": "abc123" -} -``` - - - -### NegotiableQuotesOutput - -Contains a list of negotiable that match the specified filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | - -#### Example - -```json -{ - "items": [NegotiableQuote], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 987 -} -``` - - - -### NoSuchEntityUidError - -Contains an error message when an invalid UID was specified. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | - -#### Example - -```json -{"message": "xyz789", "uid": 4} -``` - - - -### Order - -Contains the order ID. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | - -#### Example - -```json -{ - "order_id": "xyz789", - "order_number": "abc123" -} -``` - - - -### OrderAddress - -Contains detailed information about an order's billing and shipping addresses. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `fax` - [`String`](#string) | The fax number. | -| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | The state or province name. | -| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "abc123", - "country_code": "AF", - "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", - "region": "abc123", - "region_id": 4, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "xyz789" -} -``` - - - -### OrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "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_returned": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### OrderItemInterface - -Order item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Possible Types - -| OrderItemInterface Types | -|----------------| -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | -| [`OrderItem`](#orderitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "4", - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "abc123" -} -``` - - - -### OrderItemOption - -Represents order item options like selected or entered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | - -#### Example - -```json -{ - "label": "xyz789", - "value": "abc123" -} -``` - - - -### OrderPaymentMethod - -Contains details about the payment method used to pay for the order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](#string) | The label that describes the payment method. | -| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | - -#### Example - -```json -{ - "additional_data": [KeyValue], - "name": "abc123", - "type": "xyz789" -} -``` - - - -### OrderShipment - -Contains order shipment details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": 4, - "items": [ShipmentItemInterface], - "number": "xyz789", - "tracking": [ShipmentTracking] -} -``` - - - -### OrderTotal - -Contains details about the sales total amounts used to calculate the final price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | -| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | -| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_giftcard": Money, - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### PayflowExpressInput - -Contains required input for Payflow Express Checkout payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | - -#### Example - -```json -{ - "payer_id": "xyz789", - "token": "abc123" -} -``` - - - -### PayflowLinkInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "error_url": "abc123", - "return_url": "abc123" -} -``` - - - -### PayflowLinkMode - -Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TEST` | | -| `LIVE` | | - -#### Example - -```json -""TEST"" -``` - - - -### PayflowLinkToken - -Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | - -#### Example - -```json -{ - "mode": "TEST", - "paypal_url": "abc123", - "secure_token": "abc123", - "secure_token_id": "xyz789" -} -``` - - - -### PayflowLinkTokenInput - -Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PayflowProInput - -Contains input for the Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](#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 - -```json -{ - "cc_details": CreditCardDetailsInput, - "is_active_payment_token_enabler": true -} -``` - - - -### PayflowProResponseInput - -Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | - -#### Example - -```json -{ - "cart_id": "abc123", - "paypal_payload": "abc123" -} -``` - - - -### PayflowProResponseOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### PayflowProTokenInput - -Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | - -#### Example - -```json -{ - "cart_id": "abc123", - "urls": PayflowProUrlInput -} -``` - - - -### PayflowProUrlInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "error_url": "abc123", - "return_url": "xyz789" -} -``` - - - -### PaymentMethodInput - -Defines the payment method. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `braintree` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | -| `code` - [`String!`](#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | -| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | -| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | -| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | -| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | - -#### Example - -```json -{ - "braintree": BraintreeInput, - "braintree_cc_vault": BraintreeCcVaultInput, - "code": "xyz789", - "hosted_pro": HostedProInput, - "payflow_express": PayflowExpressInput, - "payflow_link": PayflowLinkInput, - "payflowpro": PayflowProInput, - "payflowpro_cc_vault": VaultTokenInput, - "paypal_express": PaypalExpressInput, - "purchase_order_number": "abc123" -} -``` - - - -### PaymentToken - -The stored payment method available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `details` - [`String`](#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](#string) | The public hash of the token. | -| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | - -#### Example - -```json -{ - "details": "xyz789", - "payment_method_code": "abc123", - "public_hash": "xyz789", - "type": "card" -} -``` - - - -### PaymentTokenTypeEnum - -The list of available payment token types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | -| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | - -#### Example - -```json -""card"" -``` - - - -### PaypalExpressInput - -Contains required input for Express Checkout and Payments Standard payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | - -#### Example - -```json -{ - "payer_id": "abc123", - "token": "abc123" -} -``` - - - -### PaypalExpressTokenInput - -Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](#string) | The payment method code. | -| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | -| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | -| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "code": "xyz789", - "express_button": true, - "urls": PaypalExpressUrlsInput, - "use_paypal_credit": true -} -``` - - - -### PaypalExpressTokenOutput - -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 Name | Description | -|------------|-------------| -| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](#string) | The token returned by PayPal. | - -#### Example - -```json -{ - "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" -} -``` - - - -### PaypalExpressUrlList - -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 Name | Description | -|------------|-------------| -| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](#string) | The URL to the PayPal login page. | - -#### Example - -```json -{ - "edit": "abc123", - "start": "xyz789" -} -``` - - - -### PaypalExpressUrlsInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 - -```json -{ - "cancel_url": "xyz789", - "pending_url": "abc123", - "return_url": "xyz789", - "success_url": "xyz789" -} -``` - - - -### PhysicalProductInterface - -Contains attributes specific to tangible products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Possible Types - -| PhysicalProductInterface Types | -|----------------| -| [`SimpleProduct`](#simpleproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`ConfigurableProduct`](#configurableproduct) | - -#### Example - -```json -{"weight": 123.45} -``` - - - -### PickupLocation - -Defines Pickup Location information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | | -| `contact_name` - [`String`](#string) | | -| `country_id` - [`String`](#string) | | -| `description` - [`String`](#string) | | -| `email` - [`String`](#string) | | -| `fax` - [`String`](#string) | | -| `latitude` - [`Float`](#float) | | -| `longitude` - [`Float`](#float) | | -| `name` - [`String`](#string) | | -| `phone` - [`String`](#string) | | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | | -| `region` - [`String`](#string) | | -| `region_id` - [`Int`](#int) | | -| `street` - [`String`](#string) | | - -#### Example - -```json -{ - "city": "xyz789", - "contact_name": "xyz789", - "country_id": "xyz789", - "description": "abc123", - "email": "abc123", - "fax": "xyz789", - "latitude": 987.65, - "longitude": 123.45, - "name": "xyz789", - "phone": "xyz789", - "pickup_location_code": "abc123", - "postcode": "abc123", - "region": "abc123", - "region_id": 987, - "street": "abc123" -} -``` - - - -### PickupLocationFilterInput - -PickupLocationFilterInput defines the list of attributes and filters for the search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | - -#### Example - -```json -{ - "city": FilterTypeInput, - "country_id": FilterTypeInput, - "name": FilterTypeInput, - "pickup_location_code": FilterTypeInput, - "postcode": FilterTypeInput, - "region": FilterTypeInput, - "region_id": FilterTypeInput, - "street": FilterTypeInput -} -``` - - - -### PickupLocationSortInput - -PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | -| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | - -#### Example - -```json -{ - "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" -} -``` - - - -### PickupLocations - -Top level object returned in a pickup locations search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](#int) | The number of products returned. | - -#### Example - -```json -{ - "items": [PickupLocation], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### PlaceNegotiableQuoteOrderInput - -Specifies the negotiable quote to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### PlaceNegotiableQuoteOrderOutput - -An output object that returns the generated order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`Order!`](#order) | Contains the generated order number. | - -#### Example - -```json -{"order": Order} -``` - - - -### PlaceOrderForPurchaseOrderInput - -Specifies the purchase order to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | - -#### Example - -```json -{"purchase_order_uid": "4"} -``` - - - -### PlaceOrderForPurchaseOrderOutput - -Contains the results of the request to place an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | - -#### Example - -```json -{"order": CustomerOrder} -``` - - - -### PlaceOrderInput - -Specifies the quote to be converted to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PlaceOrderOutput - -Contains the results of the request to place an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`Order!`](#order) | The ID of the order. | - -#### Example - -```json -{"order": Order} -``` - - - -### PlacePurchaseOrderInput - -Specifies the quote to be converted to a purchase order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PlacePurchaseOrderOutput - -Contains the results of the request to place a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | - -#### Example - -```json -{"purchase_order": PurchaseOrder} -``` - - - -### Price - -Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | -| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | - -#### Example - -```json -{ - "adjustments": [PriceAdjustment], - "amount": Money -} -``` - - - -### PriceAdjustment - -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 Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | -| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | -| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | - -#### Example - -```json -{ - "amount": Money, - "code": "TAX", - "description": "INCLUDED" -} -``` - - - -### PriceAdjustmentCodesEnum - -`PriceAdjustment.code` is deprecated. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | -| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | -| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | - -#### Example - -```json -""TAX"" -``` - - - -### PriceAdjustmentDescriptionEnum - -`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INCLUDED` | | -| `EXCLUDED` | | - -#### Example - -```json -""INCLUDED"" -``` - - - -### PriceRange - -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 Name | Description | -|------------|-------------| -| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | -| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | - -#### Example - -```json -{ - "maximum_price": ProductPrice, - "minimum_price": ProductPrice -} -``` - - - -### PriceTypeEnum - -Defines the price type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FIXED` | | -| `PERCENT` | | -| `DYNAMIC` | | - -#### Example - -```json -""FIXED"" -``` - - - -### PriceViewEnum - -Defines whether a bundle product's price is displayed as the lowest possible value or as a range. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRICE_RANGE` | | -| `AS_LOW_AS` | | - -#### Example - -```json -""PRICE_RANGE"" -``` - - - -### ProductAttribute - -Contains a product attribute code and value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | - -#### Example - -```json -{ - "code": "abc123", - "value": "xyz789" -} -``` - - - -### ProductAttributeFilterInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `activity` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Activity | -| `category_gear` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Category Gear | -| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `climate` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Climate | -| `collar` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Collar | -| `color` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Color | -| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | -| `eco_collection` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Eco Collection | -| `erin_recommends` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Erin Recommends | -| `features_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Features | -| `format` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Format | -| `gender` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Gender | -| `material` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Material | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | -| `new` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: New | -| `pattern` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Pattern | -| `performance_fabric` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Performance Fabric | -| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | -| `purpose` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Purpose | -| `sale` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sale | -| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | -| `size` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Size | -| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | -| `sleeve` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sleeve | -| `strap_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Strap/Handle | -| `style_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bags | -| `style_bottom` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bottom | -| `style_general` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style General | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | - -#### Example - -```json -{ - "activity": FilterEqualTypeInput, - "category_gear": FilterEqualTypeInput, - "category_id": FilterEqualTypeInput, - "category_uid": 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 -} -``` - - - -### ProductAttributeSortInput - -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 - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | - -#### Example - -```json -{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} -``` - - - -### ProductDiscount - -Contains the discount applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | - -#### Example - -```json -{"amount_off": 123.45, "percent_off": 987.65} -``` - - - -### ProductFilterInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | -| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | -| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "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 -} -``` - - - -### ProductImage - -Contains product image information, including the image URL and label. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Example - -```json -{ - "disabled": false, - "label": "abc123", - "position": 987, - "url": "abc123" -} -``` - - - -### ProductInfoInput - -Product Information used for Pickup Locations search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | - -#### Example - -```json -{"sku": "xyz789"} -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-3.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-3.md deleted file mode 100644 index c8f3c0dd2..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-3.md +++ /dev/null @@ -1,5818 +0,0 @@ -### ProductInterface - -Contains fields that are common to all types of products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Possible Types - -| ProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`ConfigurableProduct`](#configurableproduct) | - -#### Example - -```json -{ - "activity": "abc123", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", - "collar": "abc123", - "color": 987, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 987, - "features_bags": "xyz789", - "format": 123, - "gender": "xyz789", - "gift_message_available": "xyz789", - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 123, - "material": "xyz789", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "abc123", - "new": 987, - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 987, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 123, - "rating_summary": 123.45, - "related_products": [ProductInterface], - "review_count": 123, - "reviews": ProductReviews, - "sale": 987, - "short_description": ComplexTextValue, - "size": 123, - "sku": "xyz789", - "sleeve": "abc123", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "abc123", - "style_bottom": "xyz789", - "style_general": "xyz789", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "tier_price": 123.45, - "tier_prices": [ProductTierPrices], - "type_id": "xyz789", - "uid": "4", - "updated_at": "xyz789", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website] -} -``` - - - -### ProductLinks - -An implementation of `ProductLinksInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Example - -```json -{ - "link_type": "xyz789", - "linked_product_sku": "abc123", - "linked_product_type": "abc123", - "position": 123, - "sku": "xyz789" -} -``` - - - -### ProductLinksInterface - -Contains information about linked products, including the link type and product type of each item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Possible Types - -| ProductLinksInterface Types | -|----------------| -| [`ProductLinks`](#productlinks) | - -#### Example - -```json -{ - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 987, - "sku": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesContent - -Contains an image in base64 format and basic information about the image. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | -| `name` - [`String`](#string) | The file name of the image. | -| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | - -#### Example - -```json -{ - "base64_encoded_data": "xyz789", - "name": "abc123", - "type": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesVideoContent - -Contains a link to a video file and basic information about the video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `media_type` - [`String`](#string) | Must be external-video. | -| `video_description` - [`String`](#string) | A description of the video. | -| `video_metadata` - [`String`](#string) | Optional data about the video. | -| `video_provider` - [`String`](#string) | Describes the video source. | -| `video_title` - [`String`](#string) | The title of the video. | -| `video_url` - [`String`](#string) | The URL to the video. | - -#### Example - -```json -{ - "media_type": "abc123", - "video_description": "xyz789", - "video_metadata": "xyz789", - "video_provider": "xyz789", - "video_title": "abc123", - "video_url": "xyz789" -} -``` - - - -### ProductPrice - -Represents a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | -| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | -| `regular_price` - [`Money!`](#money) | The regular price of the product. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "fixed_product_taxes": [FixedProductTax], - "regular_price": Money -} -``` - - - -### ProductPrices - -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 Name | Description | -|------------|-------------| -| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | -| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | -| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | - -#### Example - -```json -{ - "maximalPrice": Price, - "minimalPrice": Price, - "regularPrice": Price -} -``` - - - -### ProductReview - -Contains details of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](#string) | The date the review was created. | -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | -| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | - -#### Example - -```json -{ - "average_rating": 123.45, - "created_at": "xyz789", - "nickname": "abc123", - "product": ProductInterface, - "ratings_breakdown": [ProductReviewRating], - "summary": "abc123", - "text": "xyz789" -} -``` - - - -### ProductReviewRating - -Contains data about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "abc123" -} -``` - - - -### ProductReviewRatingInput - -Contains the reviewer's rating for a single aspect of a review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "id": "xyz789", - "value_id": "abc123" -} -``` - - - -### ProductReviewRatingMetadata - -Contains details about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | - -#### Example - -```json -{ - "id": "abc123", - "name": "abc123", - "values": [ProductReviewRatingValueMetadata] -} -``` - - - -### ProductReviewRatingValueMetadata - -Contains details about a single value in a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "value": "abc123", - "value_id": "xyz789" -} -``` - - - -### ProductReviewRatingsMetadata - -Contains an array of metadata about each aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | - -#### Example - -```json -{"items": [ProductReviewRatingMetadata]} -``` - - - -### ProductReviews - -Contains an array of product reviews. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | - -#### Example - -```json -{ - "items": [ProductReview], - "page_info": SearchResultPageInfo -} -``` - - - -### ProductStockStatus - -This enumeration states whether a product stock status is in stock or out of stock - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `IN_STOCK` | | -| `OUT_OF_STOCK` | | - -#### Example - -```json -""IN_STOCK"" -``` - - - -### ProductTierPrices - -Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | - -#### Example - -```json -{ - "customer_group_id": "abc123", - "percentage_value": 123.45, - "qty": 987.65, - "value": 123.45, - "website_id": 123.45 -} -``` - - - -### ProductVideo - -Contains information about a product video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | - -#### Example - -```json -{ - "disabled": false, - "label": "abc123", - "position": 987, - "url": "abc123", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### Products - -Contains the results of a `products` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | -| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](#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 - -```json -{ - "aggregations": [Aggregation], - "filters": [LayerFilter], - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "suggestions": [SearchSuggestion], - "total_count": 987 -} -``` - - - -### PurchaseOrder - -Contains details about a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | -| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | -| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | -| `created_at` - [`String!`](#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | -| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | -| `number` - [`String!`](#string) | The purchase order number. | -| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | -| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | - -#### Example - -```json -{ - "approval_flow": [PurchaseOrderRuleApprovalFlow], - "available_actions": ["REJECT"], - "comments": [PurchaseOrderComment], - "created_at": "xyz789", - "created_by": Customer, - "history_log": [PurchaseOrderHistoryItem], - "number": "xyz789", - "order": CustomerOrder, - "quote": Cart, - "status": "PENDING", - "uid": 4, - "updated_at": "xyz789" -} -``` - - - -### PurchaseOrderAction - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REJECT` | | -| `CANCEL` | | -| `VALIDATE` | | -| `APPROVE` | | -| `PLACE_ORDER` | | - -#### Example - -```json -""REJECT"" -``` - - - -### PurchaseOrderActionError - -Contains details about a failed action. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | - -#### Example - -```json -{"message": "xyz789", "type": "NOT_FOUND"} -``` - - - -### PurchaseOrderApprovalFlowEvent - -Contains details about a single event in the approval flow of the purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | -| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](#string) | The date and time the event was updated. | - -#### Example - -```json -{ - "message": "xyz789", - "name": "abc123", - "role": "abc123", - "status": "PENDING", - "updated_at": "abc123" -} -``` - - - -### PurchaseOrderApprovalFlowItemStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVED` | | -| `REJECTED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrderApprovalRule - -Contains details about a purchase order approval rule. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | -| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | -| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](#string) | The name of the purchase order approval rule. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | - -#### Example - -```json -{ - "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" -} -``` - - - -### PurchaseOrderApprovalRuleConditionAmount - -Contains approval rule condition details, including the amount to be evaluated. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Example - -```json -{ - "amount": Money, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN" -} -``` - - - -### PurchaseOrderApprovalRuleConditionInterface - -Purchase order rule condition details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Possible Types - -| PurchaseOrderApprovalRuleConditionInterface Types | -|----------------| -| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | -| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} -``` - - - -### PurchaseOrderApprovalRuleConditionOperator - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `MORE_THAN` | | -| `LESS_THAN` | | -| `MORE_THAN_OR_EQUAL_TO` | | -| `LESS_THAN_OR_EQUAL_TO` | | - -#### Example - -```json -""MORE_THAN"" -``` - - - -### PurchaseOrderApprovalRuleConditionQuantity - -Contains approval rule condition details, including the quantity to be evaluated. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | -| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} -``` - - - -### PurchaseOrderApprovalRuleInput - -Defines a new purchase order approval rule. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](#string) | The purchase order approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | - -#### Example - -```json -{ - "applies_to": [4], - "approvers": ["4"], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "abc123", - "status": "ENABLED" -} -``` - - - -### PurchaseOrderApprovalRuleMetadata - -Contains metadata that can be used to render rule edit forms. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | - -#### Example - -```json -{ - "available_applies_to": [CompanyRole], - "available_condition_currencies": [AvailableCurrency], - "available_requires_approval_from": [CompanyRole] -} -``` - - - -### PurchaseOrderApprovalRuleStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ENABLED` | | -| `DISABLED` | | - -#### Example - -```json -""ENABLED"" -``` - - - -### PurchaseOrderApprovalRuleType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `GRAND_TOTAL` | | -| `SHIPPING_INCL_TAX` | | -| `NUMBER_OF_SKUS` | | - -#### Example - -```json -""GRAND_TOTAL"" -``` - - - -### PurchaseOrderApprovalRules - -Contains the approval rules that the customer can see. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | - -#### Example - -```json -{ - "items": [PurchaseOrderApprovalRule], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### PurchaseOrderComment - -Contains details about a comment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`Customer`](#customer) | The user who left the comment. | -| `created_at` - [`String!`](#string) | The date and time when the comment was created. | -| `text` - [`String!`](#string) | The text of the comment. | -| `uid` - [`ID!`](#id) | A unique identifier of the comment. | - -#### Example - -```json -{ - "author": Customer, - "created_at": "xyz789", - "text": "xyz789", - "uid": "4" -} -``` - - - -### PurchaseOrderErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | - -#### Example - -```json -""NOT_FOUND"" -``` - - - -### PurchaseOrderHistoryItem - -Contains details about a status change. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String!`](#string) | The activity type of the event. | -| `created_at` - [`String!`](#string) | The date and time when the event happened. | -| `message` - [`String!`](#string) | The message representation of the event. | -| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | - -#### Example - -```json -{ - "activity": "abc123", - "created_at": "abc123", - "message": "xyz789", - "uid": 4 -} -``` - - - -### PurchaseOrderRuleApprovalFlow - -Contains details about approval roles applied to the purchase order and status changes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | - -#### Example - -```json -{ - "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "abc123" -} -``` - - - -### PurchaseOrderStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVAL_REQUIRED` | | -| `APPROVED` | | -| `ORDER_IN_PROGRESS` | | -| `ORDER_PLACED` | | -| `ORDER_FAILED` | | -| `REJECTED` | | -| `CANCELED` | | -| `APPROVED_PENDING_PAYMENT` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrders - -Contains a list of purchase orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | - -#### Example - -```json -{ - "items": [PurchaseOrder], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### PurchaseOrdersActionInput - -Defines which purchase orders to act on. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of of purchase order UIDs. | - -#### Example - -```json -{"purchase_order_uids": ["4"]} -``` - - - -### PurchaseOrdersActionOutput - -Returns a list of updated purchase orders and any error messages. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | - -#### Example - -```json -{ - "errors": [PurchaseOrderActionError], - "purchase_orders": [PurchaseOrder] -} -``` - - - -### PurchaseOrdersFilterInput - -Defines the criteria to use to filter the list of purchase orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | -| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | - -#### Example - -```json -{ - "company_purchase_orders": true, - "created_date": FilterRangeTypeInput, - "require_my_approval": true, - "status": "PENDING" -} -``` - - - -### Region - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](#int) | The unique ID for a `Region` object. | -| `name` - [`String`](#string) | The name of the region, such as Texas. | - -#### Example - -```json -{ - "code": "abc123", - "id": 123, - "name": "xyz789" -} -``` - - - -### RemoveCouponFromCartInput - -Specifies the cart from which to remove a coupon. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### RemoveCouponFromCartOutput - -Contains details about the cart after removing a coupon. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveGiftCardFromCartInput - -Defines the input required to run the `removeGiftCardFromCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "gift_card_code": "abc123" -} -``` - - - -### RemoveGiftCardFromCartOutput - -Defines the possible output for the `removeGiftCardFromCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveGiftRegistryItemsOutput - -Contains the results of a request to remove an item from a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### RemoveGiftRegistryOutput - -Contains the results of a request to delete a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | - -#### Example - -```json -{"success": true} -``` - - - -### RemoveGiftRegistryRegistrantsOutput - -Contains the results of a request to delete a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### RemoveItemFromCartInput - -Specifies which items to remove from the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "cart_item_id": 123, - "cart_item_uid": 4 -} -``` - - - -### RemoveItemFromCartOutput - -Contains details about the cart after removing an item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveNegotiableQuoteItemsInput - -Defines the items to remove from the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_item_uids": [4], "quote_uid": "4"} -``` - - - -### RemoveNegotiableQuoteItemsOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### RemoveProductsFromCompareListInput - -Defines which products to remove from a compare list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | - -#### Example - -```json -{"products": ["4"], "uid": 4} -``` - - - -### RemoveProductsFromWishlistOutput - -Contains the customer's wish list and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | - -#### Example - -```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} -``` - - - -### RemoveReturnTrackingInput - -Defines the tracking information to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | - -#### Example - -```json -{"return_shipping_tracking_uid": 4} -``` - - - -### RemoveReturnTrackingOutput - -Contains the response after deleting tracking information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `return` - [`Return`](#return) | Contains details about the modified return. | - -#### Example - -```json -{"return": Return} -``` - - - -### RemoveRewardPointsFromCartOutput - -Contains the customer cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveStoreCreditFromCartInput - -Defines the input required to run the `removeStoreCreditFromCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### RemoveStoreCreditFromCartOutput - -Defines the possible output for the `removeStoreCreditFromCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ReorderItemsOutput - -Contains the cart and any errors after adding products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | - -#### Example - -```json -{ - "cart": Cart, - "userInputErrors": [CheckoutUserInputError] -} -``` - - - -### RequestNegotiableQuoteInput - -Defines properties of a negotiable quote request. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | - -#### Example - -```json -{ - "cart_id": "4", - "comment": NegotiableQuoteCommentInput, - "quote_name": "abc123" -} -``` - - - -### RequestNegotiableQuoteOutput - -Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### RequestReturnInput - -Contains information needed to start a return request. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | - -#### Example - -```json -{ - "comment_text": "xyz789", - "contact_email": "xyz789", - "items": [RequestReturnItemInput], - "order_uid": "4" -} -``` - - - -### RequestReturnItemInput - -Contains details about an item to be returned. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | -| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 - -```json -{ - "entered_custom_attributes": [ - EnteredCustomAttributeInput - ], - "order_item_uid": "4", - "quantity_to_return": 987.65, - "selected_custom_attributes": [ - SelectedCustomAttributeInput - ] -} -``` - - - -### RequestReturnOutput - -Contains the response to a return request. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `return` - [`Return`](#return) | Details about a single return request. | -| `returns` - [`Returns`](#returns) | An array of return requests. | - -#### Example - -```json -{ - "return": Return, - "returns": Returns -} -``` - - - -### RequisitionList - -Defines the contents of a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `description` - [`String`](#string) | Optional text that describes the requisition list. | -| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | -| `items_count` - [`Int!`](#int) | The number of items in the list. | -| `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | -| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | - -#### Example - -```json -{ - "description": "abc123", - "items": RequistionListItems, - "items_count": 987, - "name": "abc123", - "uid": "4", - "updated_at": "abc123" -} -``` - - - -### RequisitionListFilterInput - -Defines requisition list filters. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | - -#### Example - -```json -{ - "name": FilterMatchTypeInput, - "uids": FilterEqualTypeInput -} -``` - - - -### RequisitionListItemInterface - -The interface for requisition list items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Possible Types - -| RequisitionListItemInterface Types | -|----------------| -| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### RequisitionListItemsInput - -Defines the items to add. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | -| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](#float) | The quantity of the product to add. | -| `selected_options` - [`[String]`](#string) | Selected option IDs. | -| `sku` - [`String!`](#string) | The product SKU. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 987.65, - "selected_options": ["abc123"], - "sku": "xyz789" -} -``` - - - -### RequisitionLists - -Defines customer requisition lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | - -#### Example - -```json -{ - "items": [RequisitionList], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### RequistionListItems - -Contains an array of items added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](#int) | The number of pages returned. | - -#### Example - -```json -{ - "items": [RequisitionListItemInterface], - "page_info": SearchResultPageInfo, - "total_pages": 123 -} -``` - - - -### Return - -Contains details about a return. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | -| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | -| `created_at` - [`String!`](#string) | The date the return was requested. | -| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | -| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | -| `number` - [`String!`](#string) | A human-readable return number. | -| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | -| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | -| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | -| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | - -#### Example - -```json -{ - "available_shipping_carriers": [ReturnShippingCarrier], - "comments": [ReturnComment], - "created_at": "xyz789", - "customer": ReturnCustomer, - "items": [ReturnItem], - "number": "abc123", - "order": CustomerOrder, - "shipping": ReturnShipping, - "status": "PENDING", - "uid": 4 -} -``` - - - -### ReturnComment - -Contains details about a return comment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author_name` - [`String!`](#string) | The name or author who posted the comment. | -| `created_at` - [`String!`](#string) | The date and time the comment was posted. | -| `text` - [`String!`](#string) | The contents of the comment. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | - -#### Example - -```json -{ - "author_name": "abc123", - "created_at": "xyz789", - "text": "xyz789", - "uid": 4 -} -``` - - - -### ReturnCustomAttribute - -Contains details about a `ReturnCustomerAttribute` object. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | -| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | - -#### Example - -```json -{ - "label": "abc123", - "uid": "4", - "value": "xyz789" -} -``` - - - -### ReturnCustomer - -The customer information for the return. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `email` - [`String!`](#string) | The email address of the customer. | -| `firstname` - [`String`](#string) | The first name of the customer. | -| `lastname` - [`String`](#string) | The last name of the customer. | - -#### Example - -```json -{ - "email": "abc123", - "firstname": "xyz789", - "lastname": "xyz789" -} -``` - - - -### ReturnItem - -Contains details about a product being returned. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | -| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | - -#### Example - -```json -{ - "custom_attributes": [ReturnCustomAttribute], - "order_item": OrderItemInterface, - "quantity": 123.45, - "request_quantity": 987.65, - "status": "PENDING", - "uid": "4" -} -``` - - - -### ReturnItemStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `RECEIVED` | | -| `APPROVED` | | -| `REJECTED` | | -| `DENIED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### ReturnShipping - -Contains details about the return shipping address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | -| `tracking` - [`[ReturnShippingTracking]`](#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. | - -#### Example - -```json -{ - "address": ReturnShippingAddress, - "tracking": [ReturnShippingTracking] -} -``` - - - -### ReturnShippingAddress - -Contains details about the shipping address used for receiving returned items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city for product returns. | -| `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](#country) | An object that defines the country for product returns. | -| `postcode` - [`String!`](#string) | The postal code for product returns. | -| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | -| `street` - [`[String]!`](#string) | The street address for product returns. | -| `telephone` - [`String`](#string) | The telephone number for product returns. | - -#### Example - -```json -{ - "city": "abc123", - "contact_name": "xyz789", - "country": Country, - "postcode": "abc123", - "region": Region, - "street": ["abc123"], - "telephone": "abc123" -} -``` - - - -### ReturnShippingCarrier - -Contains details about the carrier on a return. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | - -#### Example - -```json -{"label": "abc123", "uid": 4} -``` - - - -### ReturnShippingTracking - -Contains shipping and tracking details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | -| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | -| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | - -#### Example - -```json -{ - "carrier": ReturnShippingCarrier, - "status": ReturnShippingTrackingStatus, - "tracking_number": "xyz789", - "uid": 4 -} -``` - - - -### ReturnShippingTrackingStatus - -Contains the status of a shipment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `text` - [`String!`](#string) | Text that describes the status. | -| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | - -#### Example - -```json -{"text": "xyz789", "type": "INFORMATION"} -``` - - - -### ReturnShippingTrackingStatusType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INFORMATION` | | -| `ERROR` | | - -#### Example - -```json -""INFORMATION"" -``` - - - -### ReturnStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `PARTIALLY_AUTHORIZED` | | -| `RECEIVED` | | -| `PARTIALLY_RECEIVED` | | -| `APPROVED` | | -| `PARTIALLY_APPROVED` | | -| `REJECTED` | | -| `PARTIALLY_REJECTED` | | -| `DENIED` | | -| `PROCESSED_AND_CLOSED` | | -| `CLOSED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### Returns - -Contains a list of customer return requests. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[Return]`](#return) | A list of return requests. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | - -#### Example - -```json -{ - "items": [Return], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### RevokeCustomerTokenOutput - -Contains the result of a request to revoke a customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | - -#### Example - -```json -{"result": true} -``` - - - -### RewardPoints - -Contains details about a customer's reward points. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | -| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | -| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | - -#### Example - -```json -{ - "balance": RewardPointsAmount, - "balance_history": [RewardPointsBalanceHistoryItem], - "exchange_rates": RewardPointsExchangeRates, - "subscription_status": RewardPointsSubscriptionStatus -} -``` - - - -### RewardPointsAmount - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | - -#### Example - -```json -{"money": Money, "points": 987.65} -``` - - - -### RewardPointsBalanceHistoryItem - -Contain details about the reward points transaction. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | -| `change_reason` - [`String!`](#string) | The reason the balance changed. | -| `date` - [`String!`](#string) | The date of the transaction. | -| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | - -#### Example - -```json -{ - "balance": RewardPointsAmount, - "change_reason": "abc123", - "date": "abc123", - "points_change": 987.65 -} -``` - - - -### RewardPointsExchangeRates - -Lists the reward points exchange rates. The values depend on the customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | -| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | - -#### Example - -```json -{ - "earning": RewardPointsRate, - "redemption": RewardPointsRate -} -``` - - - -### RewardPointsRate - -Contains details about customer's reward points rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_amount` - [`Float!`](#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!`](#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 - -```json -{"currency_amount": 987.65, "points": 987.65} -``` - - - -### RewardPointsSubscriptionStatus - -Indicates whether the customer subscribes to reward points emails. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | -| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | - -#### Example - -```json -{ - "balance_updates": "SUBSCRIBED", - "points_expiration_notifications": "SUBSCRIBED" -} -``` - - - -### RewardPointsSubscriptionStatusesEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SUBSCRIBED` | | -| `NOT_SUBSCRIBED` | | - -#### Example - -```json -""SUBSCRIBED"" -``` - - - -### RoutableInterface - -Routable entities serve as the model for a rendered page. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Possible Types - -| RoutableInterface Types | -|----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`ConfigurableProduct`](#configurableproduct) | - -#### Example - -```json -{ - "redirect_code": 987, - "relative_url": "xyz789", - "type": "CMS_PAGE" -} -``` - - - -### SalesCommentItem - -Contains details about a comment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The text of the message. | -| `timestamp` - [`String!`](#string) | The timestamp of the comment. | - -#### Example - -```json -{ - "message": "abc123", - "timestamp": "abc123" -} -``` - - - -### ScopeTypeEnum - -This enumeration defines the scope type for customer orders. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `GLOBAL` | | -| `WEBSITE` | | -| `STORE` | | - -#### Example - -```json -""GLOBAL"" -``` - - - -### SearchResultPageInfo - -Provides navigation for the query response. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `current_page` - [`Int`](#int) | The specific page to return. | -| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](#int) | The total number of pages in the response. | - -#### Example - -```json -{"current_page": 123, "page_size": 123, "total_pages": 123} -``` - - - -### SearchSuggestion - -A string that contains search suggestion - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `search` - [`String!`](#string) | The search suggestion of existing product. | - -#### Example - -```json -{"search": "abc123"} -``` - - - -### SelectedBundleOption - -Contains details about a selected bundle option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | -| `label` - [`String!`](#string) | The display name of the selected bundle product option. | -| `type` - [`String!`](#string) | The type of selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | -| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | - -#### Example - -```json -{ - "id": 987, - "label": "xyz789", - "type": "xyz789", - "uid": 4, - "values": [SelectedBundleOptionValue] -} -``` - - - -### SelectedBundleOptionValue - -Contains details about a value for a selected bundle option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | -| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | - -#### Example - -```json -{ - "id": 987, - "label": "abc123", - "price": 123.45, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### SelectedConfigurableOption - -Contains details about a selected configurable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | -| `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | -| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | - -#### Example - -```json -{ - "configurable_product_option_uid": 4, - "configurable_product_option_value_uid": 4, - "id": 987, - "option_label": "abc123", - "value_id": 123, - "value_label": "xyz789" -} -``` - - - -### SelectedCustomAttributeInput - -Contains details about an attribute the buyer selected. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`ID!`](#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "value": "4" -} -``` - - - -### SelectedCustomizableOption - -Identifies a customized product that has been placed in a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | -| `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | -| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | -| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | - -#### Example - -```json -{ - "customizable_option_uid": "4", - "id": 123, - "is_required": true, - "label": "abc123", - "sort_order": 123, - "type": "abc123", - "values": [SelectedCustomizableOptionValue] -} -``` - - - -### SelectedCustomizableOptionValue - -Identifies the value of the selected customized option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | -| `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | -| `value` - [`String!`](#string) | The text identifying the selected value. | - -#### Example - -```json -{ - "customizable_option_value_uid": 4, - "id": 123, - "label": "abc123", - "price": CartItemSelectedOptionValuePrice, - "value": "xyz789" -} -``` - - - -### SelectedPaymentMethod - -Describes the payment method the shopper selected. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. | -| `title` - [`String!`](#string) | The payment method title. | - -#### Example - -```json -{ - "code": "xyz789", - "purchase_order_number": "xyz789", - "title": "xyz789" -} -``` - - - -### SelectedShippingMethod - -Contains details about the selected shipping method and carrier. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | -| `method_title` - [`String!`](#string) | The label for the method code. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | - -#### Example - -```json -{ - "amount": Money, - "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", - "method_code": "abc123", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money -} -``` - - - -### SendEmailToFriendInput - -Defines the referenced product and the email sender and recipients. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | -| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | - -#### Example - -```json -{ - "product_id": 987, - "recipients": [SendEmailToFriendRecipientInput], - "sender": SendEmailToFriendSenderInput -} -``` - - - -### SendEmailToFriendOutput - -Contains information about the sender and recipients. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | - -#### Example - -```json -{ - "recipients": [SendEmailToFriendRecipient], - "sender": SendEmailToFriendSender -} -``` - - - -### SendEmailToFriendRecipient - -An output object that contains information about the recipient. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | - -#### Example - -```json -{ - "email": "abc123", - "name": "abc123" -} -``` - - - -### SendEmailToFriendRecipientInput - -Contains details about a recipient. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | - -#### Example - -```json -{ - "email": "xyz789", - "name": "abc123" -} -``` - - - -### SendEmailToFriendSender - -An output object that contains information about the sender. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | - -#### Example - -```json -{ - "email": "abc123", - "message": "xyz789", - "name": "xyz789" -} -``` - - - -### SendEmailToFriendSenderInput - -Contains details about the sender. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | - -#### Example - -```json -{ - "email": "abc123", - "message": "xyz789", - "name": "abc123" -} -``` - - - -### SendFriendConfiguration - -Contains details about the configuration of the Email to a Friend feature. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | - -#### Example - -```json -{"enabled_for_customers": false, "enabled_for_guests": true} -``` - - - -### SendNegotiableQuoteForReviewInput - -Specifies which negotiable quote to send for review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} -``` - - - -### SendNegotiableQuoteForReviewOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetBillingAddressOnCartInput - -Sets the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{ - "billing_address": BillingAddressInput, - "cart_id": "abc123" -} -``` - - - -### SetBillingAddressOnCartOutput - -Contains details about the cart after setting the billing address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetGiftOptionsOnCartInput - -Defines the gift options applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | - -#### Example - -```json -{ - "cart_id": "abc123", - "gift_message": GiftMessageInput, - "gift_receipt_included": true, - "gift_wrapping_id": 4, - "printed_card_included": false -} -``` - - - -### SetGiftOptionsOnCartOutput - -Contains the cart after gift options have been applied. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetGuestEmailOnCartInput - -Defines the guest email and cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `email` - [`String!`](#string) | The email address of the guest. | - -#### Example - -```json -{ - "cart_id": "abc123", - "email": "abc123" -} -``` - - - -### SetGuestEmailOnCartOutput - -Contains details about the cart after setting the email of a guest. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetNegotiableQuoteBillingAddressInput - -Sets the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": "4" -} -``` - - - -### SetNegotiableQuoteBillingAddressOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuotePaymentMethodInput - -Defines the payment method of the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 -} -``` - - - -### SetNegotiableQuotePaymentMethodOutput - -Contains details about the negotiable quote after setting the payment method. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuoteShippingAddressInput - -Defines the shipping address to assign to the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | - -#### Example - -```json -{ - "customer_address_id": "4", - "quote_uid": 4, - "shipping_addresses": [ - NegotiableQuoteShippingAddressInput - ] -} -``` - - - -### SetNegotiableQuoteShippingAddressOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuoteShippingMethodsInput - -Defines the shipping method to apply to the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | - -#### Example - -```json -{ - "quote_uid": "4", - "shipping_methods": [ShippingMethodInput] -} -``` - - - -### SetNegotiableQuoteShippingMethodsOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetPaymentMethodAndPlaceOrderInput - -Applies a payment method to the quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | - -#### Example - -```json -{ - "cart_id": "abc123", - "payment_method": PaymentMethodInput -} -``` - - - -### SetPaymentMethodOnCartInput - -Applies a payment method to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "payment_method": PaymentMethodInput -} -``` - - - -### SetPaymentMethodOnCartOutput - -Contains details about the cart after setting the payment method. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetShippingAddressesOnCartInput - -Specifies an array of addresses to use for shipping. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "shipping_addresses": [ShippingAddressInput] -} -``` - - - -### SetShippingAddressesOnCartOutput - -Contains details about the cart after setting the shipping addresses. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetShippingMethodsOnCartInput - -Applies one or shipping methods to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | - -#### Example - -```json -{ - "cart_id": "abc123", - "shipping_methods": [ShippingMethodInput] -} -``` - - - -### SetShippingMethodsOnCartOutput - -Contains details about the cart after setting the shipping methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ShareGiftRegistryInviteeInput - -Defines a gift registry invitee. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the gift registry invitee. | -| `name` - [`String!`](#string) | The name of the gift registry invitee. | - -#### Example - -```json -{ - "email": "xyz789", - "name": "abc123" -} -``` - - - -### ShareGiftRegistryOutput - -Contains the results of a request to share a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | - -#### Example - -```json -{"is_shared": false} -``` - - - -### ShareGiftRegistrySenderInput - -Defines the sender of an invitation to view a gift registry. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `message` - [`String!`](#string) | A brief message from the sender. | -| `name` - [`String!`](#string) | The sender of the gift registry invitation. | - -#### Example - -```json -{ - "message": "abc123", - "name": "xyz789" -} -``` - - - -### ShipBundleItemsEnum - -Defines whether bundle items must be shipped together. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TOGETHER` | | -| `SEPARATELY` | | - -#### Example - -```json -""TOGETHER"" -``` - - - -### ShipmentItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Example - -```json -{ - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 -} -``` - - - -### ShipmentItemInterface - -Order shipment item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Possible Types - -| ShipmentItemInterface Types | -|----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | -| [`ShipmentItem`](#shipmentitem) | - -#### Example - -```json -{ - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 -} -``` - - - -### ShipmentTracking - -Contains order shipment tracking details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | -| `number` - [`String`](#string) | The tracking number of the order shipment. | -| `title` - [`String!`](#string) | The shipment tracking title. | - -#### Example - -```json -{ - "carrier": "abc123", - "number": "abc123", - "title": "xyz789" -} -``` - - - -### ShippingAddressInput - -Defines a single shipping address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | - -#### Example - -```json -{ - "address": CartAddressInput, - "customer_address_id": 987, - "customer_notes": "abc123", - "pickup_location_code": "abc123" -} -``` - - - -### ShippingCartAddress - -Contains shipping addresses and methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | - -#### Example - -```json -{ - "available_shipping_methods": [AvailableShippingMethod], - "cart_items": [CartItemQuantity], - "cart_items_v2": [CartItemInterface], - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "customer_notes": "xyz789", - "firstname": "abc123", - "items_weight": 123.45, - "lastname": "abc123", - "pickup_location_code": "abc123", - "postcode": "xyz789", - "region": CartAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "telephone": "abc123", - "uid": "abc123", - "vat_id": "abc123" -} -``` - - - -### ShippingDiscount - -Defines an individual shipping discount. This discount can be applied to shipping. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | - -#### Example - -```json -{"amount": Money} -``` - - - -### ShippingHandling - -Contains details about shipping and handling costs. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | -| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](#money) | The total amount for shipping. | - -#### Example - -```json -{ - "amount_excluding_tax": Money, - "amount_including_tax": Money, - "discounts": [ShippingDiscount], - "taxes": [TaxItem], - "total_amount": Money -} -``` - - - -### ShippingMethodInput - -Defines the shipping carrier and method. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | -| `method_code` - [`String!`](#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 - -```json -{ - "carrier_code": "abc123", - "method_code": "xyz789" -} -``` - - - -### SimpleCartItem - -An implementation for simple product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "available_gift_wrapping": [GiftWrapping], - "customizable_options": [SelectedCustomizableOption], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "xyz789", - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### SimpleProduct - -Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "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": "xyz789", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 987, - "features_bags": "abc123", - "format": 987, - "gender": "abc123", - "gift_message_available": "xyz789", - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, - "material": "xyz789", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "name": "abc123", - "new": 123, - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "abc123", - "performance_fabric": 987, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 123, - "rating_summary": 987.65, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 987, - "reviews": ProductReviews, - "sale": 123, - "short_description": ComplexTextValue, - "size": 987, - "sku": "abc123", - "sleeve": "abc123", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "abc123", - "staged": false, - "stock_status": "IN_STOCK", - "strap_bags": "abc123", - "style_bags": "abc123", - "style_bottom": "abc123", - "style_general": "xyz789", - "swatch_image": "abc123", - "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": "abc123", - "websites": [Website], - "weight": 987.65 -} -``` - - - -### SimpleProductCartItemInput - -Defines a single product to add to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} -``` - - - -### SimpleRequisitionListItem - -Contains details about simple products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### SimpleWishlistItem - -Contains a simple product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### SortEnum - -Indicates whether to return results in ascending or descending order. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ASC` | | -| `DESC` | | - -#### Example - -```json -""ASC"" -``` - - - -### SortField - -Defines a possible sort field. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String`](#string) | The label of the sort field. | -| `value` - [`String`](#string) | The attribute code of the sort field. | - -#### Example - -```json -{ - "label": "xyz789", - "value": "abc123" -} -``` - - - -### SortFields - -Contains a default value for sort fields and all available sort fields. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `default` - [`String`](#string) | The default sort field value. | -| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | - -#### Example - -```json -{ - "default": "abc123", - "options": [SortField] -} -``` - - - -### StoreConfig - -Contains information about a store's configuration. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `<body>` tag. | -| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | -| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | -| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | -| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | -| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | -| `base_currency_code` - [`String`](#string) | The base currency code. | -| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | -| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | -| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | -| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | -| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | -| `cart_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | -| `catalog_default_sort_by` - [`String`](#string) | The default sort order of the search results list. | -| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | -| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | -| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | -| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | -| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | -| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | -| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | -| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | -| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | -| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | -| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | -| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | -| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | -| `default_description` - [`String`](#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`](#string) | The default display currency code. | -| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | -| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | -| `demonotice` - [`Int`](#int) | Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes). | -| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | -| `front` - [`String`](#string) | The landing page that is associated with the base URL. | -| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | -| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | -| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `<head>` tag. | -| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | -| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | -| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | -| `list_mode` - [`String`](#string) | The format of the search results list. | -| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | -| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | -| `locale` - [`String`](#string) | The store locale. | -| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | -| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | -| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | -| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | -| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | -| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | -| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | -| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | -| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | -| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | -| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | -| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | -| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | -| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | -| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | -| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | -| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | -| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | -| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | -| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | -| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | -| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | -| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | -| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | -| `store_group_name` - [`String`](#string) | The label assigned to the store group. | -| `store_name` - [`String`](#string) | The label assigned to the store view. | -| `store_sort_order` - [`Int`](#int) | The store view sort order. | -| `timezone` - [`String`](#string) | The time zone of the store. | -| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | -| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | -| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | -| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](#id) | The unique ID for the website. | -| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | -| `website_name` - [`String`](#string) | The label assigned to the website. | -| `weight_unit` - [`String`](#string) | The unit of weight. | -| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | -| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | -| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | -| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | - -#### Example - -```json -{ - "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": "abc123", - "allow_items": "xyz789", - "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": "abc123", - "base_url": "abc123", - "braintree_cc_vault_active": "abc123", - "cart_gift_wrapping": "abc123", - "cart_printed_card": "abc123", - "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": true, - "check_money_order_enabled": false, - "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": "abc123", - "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", - "cms_home_page": "xyz789", - "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", - "code": "xyz789", - "configurable_thumbnail_source": "xyz789", - "copyright": "abc123", - "default_description": "abc123", - "default_display_currency_code": "xyz789", - "default_keywords": "abc123", - "default_title": "xyz789", - "demonotice": 123, - "enable_multiple_wishlists": "abc123", - "front": "abc123", - "grid_per_page": 987, - "grid_per_page_values": "xyz789", - "head_includes": "abc123", - "head_shortcut_icon": "abc123", - "header_logo_src": "abc123", - "id": 123, - "is_default_store": false, - "is_default_store_group": false, - "is_negotiable_quote_active": false, - "is_requisition_list_active": "xyz789", - "list_mode": "abc123", - "list_per_page": 123, - "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": "abc123", - "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": "abc123", - "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", - "maximum_number_of_wishlists": "xyz789", - "minimum_password_length": "abc123", - "no_route": "xyz789", - "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "abc123", - "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", - "product_url_suffix": "xyz789", - "required_character_classes_number": "abc123", - "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": "xyz789", - "secure_base_static_url": "abc123", - "secure_base_url": "abc123", - "send_friend": SendFriendConfiguration, - "show_cms_breadcrumbs": 123, - "store_code": 4, - "store_group_code": 4, - "store_group_name": "abc123", - "store_name": "abc123", - "store_sort_order": 123, - "timezone": "xyz789", - "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "abc123", - "use_store_in_url": true, - "website_code": "4", - "website_id": 987, - "website_name": "xyz789", - "weight_unit": "abc123", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, - "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": "abc123" -} -``` - - - -### StorefrontProperties - -Indicates where an attribute can be displayed. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | - -#### Example - -```json -{ - "position": 123, - "use_in_layered_navigation": "NO", - "use_in_product_listing": true, - "use_in_search_results_layered_navigation": false, - "visible_on_catalog_pages": false -} -``` - - - -### String - -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 - -```json -"abc123" -``` - - - -### SubscribeEmailToNewsletterOutput - -Contains the result of the `subscribeEmailToNewsletter` operation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | - -#### Example - -```json -{"status": "NOT_ACTIVE"} -``` - - - -### SubscriptionStatusesEnum - -Indicates the status of the request. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_ACTIVE` | | -| `SUBSCRIBED` | | -| `UNSUBSCRIBED` | | -| `UNCONFIRMED` | | - -#### Example - -```json -""NOT_ACTIVE"" -``` - - - -### SwatchData - -Describes the swatch type and a value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | -| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | - -#### Example - -```json -{ - "type": "xyz789", - "value": "xyz789" -} -``` - - - -### SwatchDataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Possible Types - -| SwatchDataInterface Types | -|----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | - -#### Example - -```json -{"value": "abc123"} -``` - - - -### SwatchLayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 123, - "label": "abc123", - "swatch_data": SwatchData, - "value_string": "xyz789" -} -``` - - - -### SwatchLayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | - -#### Possible Types - -| SwatchLayerFilterItemInterface Types | -|----------------| -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{"swatch_data": SwatchData} -``` - - - -### TaxItem - -Contains tax item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | -| `title` - [`String!`](#string) | A title that describes the tax. | - -#### Example - -```json -{ - "amount": Money, - "rate": 123.45, - "title": "xyz789" -} -``` - - - -### TextSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{"value": "xyz789"} -``` - - - -### TierPrice - -Defines a price based on the quantity purchased. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](#money) | The price of the product at this tier. | -| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "quantity": 123.45 -} -``` - - - -### UpdateCartItemsInput - -Modifies the specified items in the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | - -#### Example - -```json -{ - "cart_id": "abc123", - "cart_items": [CartItemUpdateInput] -} -``` - - - -### UpdateCartItemsOutput - -Contains details about the cart after updating items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### UpdateCompanyOutput - -Contains the response to the request to update the company. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | - -#### Example - -```json -{"company": Company} -``` - - - -### UpdateCompanyRoleOutput - -Contains the response to the request to update the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | - -#### Example - -```json -{"role": CompanyRole} -``` - - - -### UpdateCompanyStructureOutput - -Contains the response to the request to update the company structure. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | - -#### Example - -```json -{"company": Company} -``` - - - -### UpdateCompanyTeamOutput - -Contains the response to the request to update a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | - -#### Example - -```json -{"team": CompanyTeam} -``` - - - -### UpdateCompanyUserOutput - -Contains the response to the request to update the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | - -#### Example - -```json -{"user": Customer} -``` - - - -### UpdateGiftRegistryInput - -Defines updates to a `GiftRegistry` object. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](#string) | The updated name of the event. | -| `message` - [`String`](#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "abc123", - "message": "abc123", - "privacy_settings": "PRIVATE", - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" -} -``` - - - -### UpdateGiftRegistryItemInput - -Defines updates to an item in a gift registry. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](#string) | The updated description of the item. | -| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | - -#### Example - -```json -{ - "gift_registry_item_uid": 4, - "note": "abc123", - "quantity": 123.45 -} -``` - - - -### UpdateGiftRegistryItemsOutput - -Contains the results of a request to update gift registry items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateGiftRegistryOutput - -Contains the results of a request to update a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateGiftRegistryRegistrantInput - -Defines updates to an existing registrant. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | -| `firstname` - [`String`](#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](#string) | The updated last name of the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "abc123", - "firstname": "abc123", - "gift_registry_registrant_uid": 4, - "lastname": "xyz789" -} -``` - - - -### UpdateGiftRegistryRegistrantsOutput - -Contains the results a request to update registrants. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateNegotiableQuoteItemsQuantityOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### UpdateNegotiableQuoteQuantitiesInput - -Specifies the items to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 -} -``` - - - -### UpdateProductsInWishlistOutput - -Contains the customer's wish list and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | - -#### Example - -```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} -``` - - - -### UpdatePurchaseOrderApprovalRuleInput - -Defines the changes to be made to an approval rule. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](#string) | The updated approval rule description. | -| `name` - [`String`](#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | - -#### Example - -```json -{ - "applies_to": ["4"], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "abc123", - "status": "ENABLED", - "uid": "4" -} -``` - - - -### UpdateRequisitionListInput - -An input object that defines which requistion list characteristics to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | - -#### Example - -```json -{ - "description": "abc123", - "name": "xyz789" -} -``` - - - -### UpdateRequisitionListItemsInput - -Defines which items in a requisition list to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "item_id": 4, - "quantity": 123.45, - "selected_options": ["xyz789"] -} -``` - - - -### UpdateRequisitionListItemsOutput - -Output of the request to update items in the specified requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateRequisitionListOutput - -Output of the request to rename the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateWishlistOutput - -Contains the name and visibility of an updated wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | - -#### Example - -```json -{ - "name": "abc123", - "uid": 4, - "visibility": "PUBLIC" -} -``` - - - -### UrlRewrite - -Contains URL rewrite details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | - -#### Example - -```json -{ - "parameters": [HttpQueryParameter], - "url": "xyz789" -} -``` - - - -### UrlRewriteEntityTypeEnum - -This enumeration defines the entity type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CMS_PAGE` | | -| `PRODUCT` | | -| `CATEGORY` | | - -#### Example - -```json -""CMS_PAGE"" -``` - - - -### UseInLayeredNavigationOptions - -Defines whether the attribute is filterable in layered navigation. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NO` | | -| `FILTERABLE_WITH_RESULTS` | | -| `FILTERABLE_NO_RESULT` | | - -#### Example - -```json -""NO"" -``` - - - -### ValidatePurchaseOrderError - -Contains details about a failed validation attempt. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | - -#### Example - -```json -{"message": "abc123", "type": "NOT_FOUND"} -``` - - - -### ValidatePurchaseOrderErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | - -#### Example - -```json -""NOT_FOUND"" -``` - - - -### ValidatePurchaseOrdersInput - -Defines the purchase orders to be validated. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | - -#### Example - -```json -{"purchase_order_uids": ["4"]} -``` - - - -### ValidatePurchaseOrdersOutput - -Contains the results of validation attempts. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | - -#### Example - -```json -{ - "errors": [ValidatePurchaseOrderError], - "purchase_orders": [PurchaseOrder] -} -``` - - - -### VaultTokenInput - -Contains required input for payment methods with Vault support. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | - -#### Example - -```json -{"public_hash": "xyz789"} -``` - - - -### VirtualCartItem - -An implementation for virtual product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "errors": [CartItemError], - "id": "abc123", - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" -} -``` - - - -### VirtualProduct - -Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "xyz789", - "collar": "xyz789", - "color": 987, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 123, - "features_bags": "xyz789", - "format": 123, - "gender": "abc123", - "gift_message_available": "xyz789", - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, - "material": "abc123", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "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": "xyz789", - "performance_fabric": 123, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 987, - "rating_summary": 123.45, - "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": 123.45, - "special_to_date": "abc123", - "staged": true, - "stock_status": "IN_STOCK", - "strap_bags": "xyz789", - "style_bags": "abc123", - "style_bottom": "xyz789", - "style_general": "abc123", - "swatch_image": "abc123", - "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": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website] -} -``` - - - -### VirtualProductCartItemInput - -Defines a single product to add to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} -``` - - - -### VirtualRequisitionListItem - -Contains details about virtual products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### VirtualWishlistItem - -Contains a virtual product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### Website - -Deprecated. It should not be used on the storefront. Contains information about a website. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | -| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "code": "xyz789", - "default_group_id": "abc123", - "id": 123, - "is_default": true, - "name": "abc123", - "sort_order": 123 -} -``` - - - -### WishListUserInputError - -An error encountered while performing operations with WishList. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" -} -``` - - - -### WishListUserInputErrorType - -A list of possible error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `UNDEFINED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### Wishlist - -Contains a customer wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | -| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. | -| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | -| `name` - [`String`](#string) | The name of the wish list. | -| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | - -#### Example - -```json -{ - "id": 4, - "items": [WishlistItem], - "items_count": 123, - "items_v2": WishlistItems, - "name": "xyz789", - "sharing_code": "xyz789", - "updated_at": "abc123", - "visibility": "PUBLIC" -} -``` - - - -### WishlistCartUserInputError - -Contains details about errors encountered when a customer added wish list items to the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](#string) | A localized error message. | -| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", - "wishlistId": "4", - "wishlistItemId": "4" -} -``` - - - -### WishlistCartUserInputErrorType - -A list of possible error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### WishlistItem - -Contains details about a wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](#string) | The customer's comment about this item. | -| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](#float) | The quantity of this wish list item | - -#### Example - -```json -{ - "added_at": "abc123", - "description": "xyz789", - "id": 987, - "product": ProductInterface, - "qty": 987.65 -} -``` - - - -### WishlistItemCopyInput - -Specifies the IDs of items to copy and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | - -#### Example - -```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} -``` - - - -### WishlistItemInput - -Defines the items to add to a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": [4], - "sku": "abc123" -} -``` - - - -### WishlistItemInterface - -The interface for wish list items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Possible Types - -| WishlistItemInterface Types | -|----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | -| [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### WishlistItemMoveInput - -Specifies the IDs of the items to move and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | - -#### Example - -```json -{"quantity": 123.45, "wishlist_item_id": 4} -``` - - - -### WishlistItemUpdateInput - -Defines updates to items in a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | - -#### Example - -```json -{ - "description": "xyz789", - "entered_options": [EnteredOptionInput], - "quantity": 987.65, - "selected_options": ["4"], - "wishlist_item_id": 4 -} -``` - - - -### WishlistItems - -Contains an array of items in a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | - -#### Example - -```json -{ - "items": [WishlistItemInterface], - "page_info": SearchResultPageInfo -} -``` - - - -### WishlistOutput - -Deprecated: Use the `Wishlist` type instead. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | -| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | - -#### Example - -```json -{ - "items": [WishlistItem], - "items_count": 123, - "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "xyz789" -} -``` - - - -### WishlistVisibilityEnum - -Defines the wish list visibility types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PUBLIC` | | -| `PRIVATE` | | - -#### Example - -```json -""PUBLIC"" -``` - - - -### createEmptyCartInput - -Assigns a specific `cart_id` to the empty cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-a-b.md new file mode 100644 index 000000000..2be238211 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-a-b.md @@ -0,0 +1,1814 @@ +## Types + +### AddBundleProductsToCartInput + +Defines the bundle products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [BundleProductCartItemInput] +} +``` + + + +### AddBundleProductsToCartOutput + +Contains details about the cart after adding bundle products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddConfigurableProductsToCartInput + +Defines the configurable products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [ConfigurableProductCartItemInput] +} +``` + + + +### AddConfigurableProductsToCartOutput + +Contains details about the cart after adding configurable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddDownloadableProductsToCartInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [DownloadableProductCartItemInput] +} +``` + + + +### AddDownloadableProductsToCartOutput + +Contains details about the cart after adding downloadable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddGiftRegistryRegistrantInput + +Defines a new registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](#string) | The email address of the registrant. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### AddGiftRegistryRegistrantsOutput + +Contains the results of a request to add registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### AddProductsToCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [CartUserInputError] +} +``` + + + +### AddProductsToCompareListInput + +Contains products to add to an existing compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": [4], "uid": 4} +``` + + + +### AddProductsToRequisitionListOutput + +Output of the request to add products to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### AddProductsToWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### AddPurchaseOrderCommentInput + +Contains the comment to be added to a purchase order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | + +#### Example + +```json +{ + "comment": "xyz789", + "purchase_order_uid": "4" +} +``` + + + +### AddPurchaseOrderCommentOutput + +Contains the successfully added comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | + +#### Example + +```json +{"comment": PurchaseOrderComment} +``` + + + +### AddPurchaseOrderItemsToCartInput + +Defines the purchase order and cart to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | + +#### Example + +```json +{ + "cart_id": "abc123", + "purchase_order_uid": "4", + "replace_existing_cart_items": true +} +``` + + + +### AddRequisitionListItemToCartUserError + +Contains details about why an attempt to add items to the requistion list failed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | A description of the error. | +| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | + +#### Example + +```json +{ + "message": "xyz789", + "type": "OUT_OF_STOCK" +} +``` + + + +### AddRequisitionListItemToCartUserErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OUT_OF_STOCK` | | +| `UNAVAILABLE_SKU` | | +| `OPTIONS_UPDATED` | | +| `LOW_QUANTITY` | | + +#### Example + +```json +""OUT_OF_STOCK"" +``` + + + +### AddRequisitionListItemsToCartOutput + +Output of the request to add items in a requisition list to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | +| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | + +#### Example + +```json +{ + "add_requisition_list_items_to_cart_user_errors": [ + AddRequisitionListItemToCartUserError + ], + "cart": Cart, + "status": false +} +``` + + + +### AddReturnCommentInput + +Defines a return comment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String!`](#string) | The text added to the return request. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "comment_text": "xyz789", + "return_uid": "4" +} +``` + + + +### AddReturnCommentOutput + +Contains details about the return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | The modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### AddReturnTrackingInput + +Defines tracking information to be added to the return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | + +#### Example + +```json +{ + "carrier_uid": 4, + "return_uid": 4, + "tracking_number": "xyz789" +} +``` + + + +### AddReturnTrackingOutput + +Contains the response after adding tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | + +#### Example + +```json +{ + "return": Return, + "return_shipping_tracking": ReturnShippingTracking +} +``` + + + +### AddSimpleProductsToCartInput + +Defines the simple and group products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [SimpleProductCartItemInput] +} +``` + + + +### AddSimpleProductsToCartOutput + +Contains details about the cart after adding simple or group products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddVirtualProductsToCartInput + +Defines the virtual products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [VirtualProductCartItemInput] +} +``` + + + +### AddVirtualProductsToCartOutput + +Contains details about the cart after adding virtual products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddWishlistItemsToCartOutput + +Contains the resultant wish list and any error information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "add_wishlist_items_to_cart_user_errors": [ + WishlistCartUserInputError + ], + "status": true, + "wishlist": Wishlist +} +``` + + + +### Aggregation + +Contains information for each filterable option (such as price, category `UID`, and custom attributes). + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](#int) | The number of options in the aggregation group. | +| `label` - [`String`](#string) | The aggregation display name. | +| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | +| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "count": 123, + "label": "abc123", + "options": [AggregationOption], + "position": 123 +} +``` + + + +### AggregationOption + +An implementation of `AggregationOptionInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Example + +```json +{ + "count": 123, + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AggregationOptionInterface + +Defines aggregation option fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Possible Types + +| AggregationOptionInterface Types | +|----------------| +| [`AggregationOption`](#aggregationoption) | + +#### Example + +```json +{ + "count": 987, + "label": "abc123", + "value": "xyz789" +} +``` + + + +### AggregationsCategoryFilterInput + +Filter category aggregations in layered navigation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | + +#### Example + +```json +{"includeDirectChildrenOnly": true} +``` + + + +### AggregationsFilterInput + +An input object that specifies the filters used in product aggregations. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | + +#### Example + +```json +{"category": AggregationsCategoryFilterInput} +``` + + + +### AppliedCoupon + +Contains the applied coupon code. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | + +#### Example + +```json +{"code": "xyz789"} +``` + + + +### AppliedGiftCard + +Contains an applied gift card with applied and remaining balance. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | +| `code` - [`String`](#string) | The gift card account code. | +| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "abc123", + "current_balance": Money, + "expiration_date": "xyz789" +} +``` + + + +### AppliedStoreCredit + +Contains the applied and current balances. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | + +#### Example + +```json +{ + "applied_balance": Money, + "current_balance": Money, + "enabled": true +} +``` + + + +### ApplyCouponToCartInput + +Specifies the coupon code to apply to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](#string) | A valid coupon code. | + +#### Example + +```json +{ + "cart_id": "abc123", + "coupon_code": "abc123" +} +``` + + + +### ApplyCouponToCartOutput + +Contains details about the cart after applying a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyGiftCardToCartInput + +Defines the input required to run the `applyGiftCardToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "gift_card_code": "abc123" +} +``` + + + +### ApplyGiftCardToCartOutput + +Defines the possible output for the `applyGiftCardToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyRewardPointsToCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyStoreCreditToCartInput + +Defines the input required to run the `applyStoreCreditToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### ApplyStoreCreditToCartOutput + +Defines the possible output for the `applyStoreCreditToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AreaInput + +AreaInput defines the parameters which will be used for filter by specified location. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `radius` - [`Int!`](#int) | The radius for the search in KM. | +| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | + +#### Example + +```json +{"radius": 123, "search_term": "xyz789"} +``` + + + +### AssignCompareListToCustomerOutput + +Contains the results of the request to assign a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | + +#### Example + +```json +{"compare_list": CompareList, "result": false} +``` + + + +### Attribute + +Contains details about the attribute, including the code and type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | +| `attribute_type` - [`String`](#string) | The data type of the attribute. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "attribute_options": [AttributeOption], + "attribute_type": "abc123", + "entity_type": "xyz789", + "input_type": "abc123", + "storefront_properties": StorefrontProperties +} +``` + + + +### AttributeInput + +Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "entity_type": "abc123" +} +``` + + + +### AttributeOption + +Defines an attribute option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label assigned to the attribute option. | +| `value` - [`String`](#string) | The attribute option value. | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### AvailableCurrency + +Defines the code and symbol of a currency that can be used for purchase orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](#string) | Currency symbol, for example $. | + +#### Example + +```json +{"code": "AFN", "symbol": "xyz789"} +``` + + + +### AvailablePaymentMethod + +Describes a payment method that the shopper can use to pay for the order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "is_deferred": true, + "title": "abc123" +} +``` + + + +### AvailableShippingMethod + +Contains details about the possible shipping methods and carriers. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `error_message` - [`String`](#string) | Describes an error condition. | +| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "available": true, + "base_amount": Money, + "carrier_code": "xyz789", + "carrier_title": "abc123", + "error_message": "abc123", + "method_code": "xyz789", + "method_title": "xyz789", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### BatchMutationStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUCCESS` | | +| `FAILURE` | | +| `MIXED_RESULTS` | | + +#### Example + +```json +""SUCCESS"" +``` + + + +### BillingAddressInput + +Defines the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | +| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 123, + "same_as_shipping": false, + "use_for_shipping": false +} +``` + + + +### BillingCartAddress + +Contains details about the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "city": "xyz789", + "company": "xyz789", + "country": CartAddressCountry, + "customer_notes": "xyz789", + "firstname": "abc123", + "lastname": "xyz789", + "postcode": "abc123", + "region": CartAddressRegion, + "street": ["xyz789"], + "telephone": "abc123", + "uid": "xyz789", + "vat_id": "abc123" +} +``` + + + +### Boolean + +The `Boolean` scalar type represents `true` or `false`. + + + +### BraintreeCcVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "xyz789", + "public_hash": "xyz789" +} +``` + + + +### BraintreeInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#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!`](#boolean) | States whether an entered by a customer credit/debit card should be tokenized for later usage. Required only if Vault is enabled for Braintree payment integration. | +| `payment_method_nonce` - [`String!`](#string) | The one-time payment token generated by Braintree payment gateway based on card details. Required field to make sale transaction. | + +#### Example + +```json +{ + "device_data": "abc123", + "is_active_payment_token_enabler": true, + "payment_method_nonce": "xyz789" +} +``` + + + +### Breadcrumb + +Contains details about an individual category that comprises a breadcrumb. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](#int) | The category level. | +| `category_name` - [`String`](#string) | The display name of the category. | +| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](#string) | The URL key of the category. | +| `category_url_path` - [`String`](#string) | The URL path of the category. | + +#### Example + +```json +{ + "category_id": 987, + "category_level": 123, + "category_name": "xyz789", + "category_uid": "4", + "category_url_key": "xyz789", + "category_url_path": "xyz789" +} +``` + + + +### BundleCartItem + +An implementation for bundle product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "available_gift_wrapping": [GiftWrapping], + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "xyz789", + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### BundleCreditMemoItem + +Defines bundle product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 123.45 +} +``` + + + +### BundleInvoiceItem + +Defines bundle product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### BundleItem + +Defines an individual item within a bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | +| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | +| `sku` - [`String`](#string) | The SKU of the bundle product. | +| `title` - [`String`](#string) | The display name of the item. | +| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | + +#### Example + +```json +{ + "option_id": 987, + "options": [BundleItemOption], + "position": 987, + "price_range": PriceRange, + "required": false, + "sku": "xyz789", + "title": "abc123", + "type": "xyz789", + "uid": 4 +} +``` + + + +### BundleItemOption + +Defines the characteristics that comprise a specific bundle item and its options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | +| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | +| `label` - [`String`](#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | + +#### Example + +```json +{ + "can_change_quantity": false, + "id": 123, + "is_default": true, + "label": "xyz789", + "position": 123, + "price": 987.65, + "price_type": "FIXED", + "product": ProductInterface, + "qty": 987.65, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### BundleOptionInput + +Defines the input for a bundle option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`Int!`](#int) | The ID of the option. | +| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | + +#### Example + +```json +{ + "id": 987, + "quantity": 987.65, + "value": ["abc123"] +} +``` + + + +### BundleOrderItem + +Defines bundle product options for `OrderItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "abc123" +} +``` + + + +### BundleProduct + +Defines basic features of a bundle product and contains multiple BundleItems. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | +| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | +| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "xyz789", + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "category_gear": "xyz789", + "climate": "xyz789", + "collar": "abc123", + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "dynamic_price": false, + "dynamic_sku": false, + "dynamic_weight": true, + "eco_collection": 123, + "erin_recommends": 123, + "features_bags": "abc123", + "format": 987, + "gender": "abc123", + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "items": [BundleItem], + "manufacturer": 123, + "material": "abc123", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "name": "abc123", + "new": 987, + "new_from_date": "abc123", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "pattern": "xyz789", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "price_view": "PRICE_RANGE", + "product_links": [ProductLinksInterface], + "purpose": 987, + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 123, + "reviews": ProductReviews, + "sale": 123, + "ship_bundle_items": "TOGETHER", + "short_description": ComplexTextValue, + "size": 123, + "sku": "abc123", + "sleeve": "abc123", + "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": "xyz789", + "style_bottom": "xyz789", + "style_general": "xyz789", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "tier_price": 987.65, + "tier_prices": [ProductTierPrices], + "type": "CMS_PAGE", + "type_id": "abc123", + "uid": "4", + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### BundleProductCartItemInput + +Defines a single bundle product. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | + +#### Example + +```json +{ + "bundle_options": [BundleOptionInput], + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### BundleRequisitionListItem + +Contains details about bundle products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | + +#### Example + +```json +{ + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleShipmentItem + +Defines bundle product options for `ShipmentItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 123.45 +} +``` + + + +### BundleWishlistItem + +Defines bundle product options for `WishlistItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-1.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md similarity index 71% rename from src/pages/includes/autogenerated/graphql-api-2-4-6-types-1.md rename to src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md index 347684355..b1537c38c 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-1.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-c-e.md @@ -1,6529 +1,6138 @@ ## Types -### AddBundleProductsToCartInput +### Cart -Defines the bundle products to add to the cart. +Contains the contents and other details about a guest or customer cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | +| Field Name | Description | +|------------|-------------| +| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. | +| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [BundleProductCartItemInput] + "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], + "prices": CartPrices, + "printed_card_included": true, + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [ShippingCartAddress], + "total_quantity": 987.65 } ``` -### AddBundleProductsToCartOutput +### CartAddressCountry -Contains details about the cart after adding bundle products. +Contains details the country in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `code` - [`String!`](#string) | The country code. | +| `label` - [`String!`](#string) | The display label for the country. | #### Example ```json -{"cart": Cart} +{ + "code": "abc123", + "label": "xyz789" +} ``` -### AddConfigurableProductsToCartInput +### CartAddressInput -Defines the configurable products to add to the cart. +Defines the billing or shipping address to be applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "cart_id": "abc123", - "cart_items": [ConfigurableProductCartItemInput] + "city": "xyz789", + "company": "xyz789", + "country_code": "xyz789", + "firstname": "abc123", + "lastname": "abc123", + "postcode": "abc123", + "region": "xyz789", + "region_id": 987, + "save_in_address_book": true, + "street": ["abc123"], + "telephone": "xyz789", + "vat_id": "xyz789" } ``` -### AddConfigurableProductsToCartOutput - -Contains details about the cart after adding configurable products. +### CartAddressInterface #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddDownloadableProductsToCartInput +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| CartAddressInterface Types | +|----------------| +| [`ShippingCartAddress`](#shippingcartaddress) | +| [`BillingCartAddress`](#billingcartaddress) | #### Example ```json { - "cart_id": "abc123", - "cart_items": [DownloadableProductCartItemInput] + "city": "xyz789", + "company": "abc123", + "country": CartAddressCountry, + "firstname": "abc123", + "lastname": "abc123", + "postcode": "xyz789", + "region": CartAddressRegion, + "street": ["abc123"], + "telephone": "xyz789", + "uid": "xyz789", + "vat_id": "xyz789" } ``` -### AddDownloadableProductsToCartOutput +### CartAddressRegion -Contains details about the cart after adding downloadable products. +Contains details about the region in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `code` - [`String`](#string) | The state or province code. | +| `label` - [`String`](#string) | The display label for the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json -{"cart": Cart} +{ + "code": "abc123", + "label": "abc123", + "region_id": 123 +} ``` -### AddGiftRegistryRegistrantInput +### CartDiscount -Defines a new registrant. +Contains information about discounts applied to the cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](#string) | The email address of the registrant. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](#string) | The description of the discount. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "abc123", - "firstname": "abc123", - "lastname": "xyz789" + "amount": Money, + "label": ["xyz789"] } ``` -### AddGiftRegistryRegistrantsOutput - -Contains the results of a request to add registrants. +### CartItemError #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | +| `message` - [`String!`](#string) | A localized error message | #### Example ```json -{"gift_registry": GiftRegistry} +{"code": "UNDEFINED", "message": "xyz789"} ``` -### AddProductsToCartOutput - -Contains details about the cart after adding products to it. +### CartItemErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `UNDEFINED` | | +| `ITEM_QTY` | | +| `ITEM_INCREMENTS` | | #### Example ```json -{ - "cart": Cart, - "user_errors": [CartUserInputError] -} +""UNDEFINED"" ``` -### AddProductsToCompareListInput +### CartItemInput -Contains products to add to an existing compare list. +Defines an item to be added to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | +| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | #### Example ```json { - "products": ["4"], - "uid": "4" + "entered_options": [EnteredOptionInput], + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": [4], + "sku": "xyz789" } ``` -### AddProductsToRequisitionListOutput +### CartItemInterface -Output of the request to add products to a requisition list. +An interface for products in a cart. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Possible Types + +| CartItemInterface Types | +|----------------| +| [`SimpleCartItem`](#simplecartitem) | +| [`VirtualCartItem`](#virtualcartitem) | +| [`DownloadableCartItem`](#downloadablecartitem) | +| [`BundleCartItem`](#bundlecartitem) | +| [`GiftCardCartItem`](#giftcardcartitem) | +| [`ConfigurableCartItem`](#configurablecartitem) | #### Example ```json -{"requisition_list": RequisitionList} +{ + "errors": [CartItemError], + "id": "abc123", + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} ``` -### AddProductsToWishlistOutput +### CartItemPrices -Contains the customer's wish list and any errors encountered. +Contains details about the price of the item, including taxes and discounts. #### Fields | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | +| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "discounts": [Discount], + "fixed_product_taxes": [FixedProductTax], + "price": Money, + "price_including_tax": Money, + "row_total": Money, + "row_total_including_tax": Money, + "total_item_discount": Money } ``` -### AddPurchaseOrderCommentInput +### CartItemQuantity -Contains the comment to be added to a purchase order. +Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| Field Name | Description | +|------------|-------------| +| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{ - "comment": "xyz789", - "purchase_order_uid": "4" -} +{"cart_item_id": 987, "quantity": 123.45} ``` -### AddPurchaseOrderCommentOutput +### CartItemSelectedOptionValuePrice -Contains the successfully added comment. +Contains details about the price of a selected customizable value. #### Fields | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](#float) | A price value. | #### Example ```json -{"comment": PurchaseOrderComment} +{ + "type": "FIXED", + "units": "abc123", + "value": 987.65 +} ``` -### AddPurchaseOrderItemsToCartInput +### CartItemUpdateInput -Defines the purchase order and cart to act on. +A single item to be updated. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | -| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | #### Example ```json { - "cart_id": "abc123", - "purchase_order_uid": "4", - "replace_existing_cart_items": true + "cart_item_id": 123, + "cart_item_uid": "4", + "customizable_options": [CustomizableOptionInput], + "gift_message": GiftMessageInput, + "gift_wrapping_id": "4", + "quantity": 987.65 } ``` -### AddRequisitionListItemToCartUserError +### CartPrices -Contains details about why an attempt to add items to the requistion list failed. +Contains details about the final price of items in the cart, including discount and tax information. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | -| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | +| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | +| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | +| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | +| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | #### Example ```json { - "message": "abc123", - "type": "OUT_OF_STOCK" -} -``` - - - -### AddRequisitionListItemToCartUserErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `OUT_OF_STOCK` | | -| `UNAVAILABLE_SKU` | | -| `OPTIONS_UPDATED` | | -| `LOW_QUANTITY` | | - -#### Example - -```json -""OUT_OF_STOCK"" + "applied_taxes": [CartTaxItem], + "discount": CartDiscount, + "discounts": [Discount], + "gift_options": GiftOptionsPrices, + "grand_total": Money, + "subtotal_excluding_tax": Money, + "subtotal_including_tax": Money, + "subtotal_with_discount_excluding_tax": Money +} ``` -### AddRequisitionListItemsToCartOutput +### CartTaxItem -Output of the request to add items in a requisition list to the cart. +Contains tax information about an item in the cart. #### Fields | Field Name | Description | |------------|-------------| -| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | -| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `label` - [`String!`](#string) | The description of the tax. | #### Example ```json { - "add_requisition_list_items_to_cart_user_errors": [ - AddRequisitionListItemToCartUserError - ], - "cart": Cart, - "status": true + "amount": Money, + "label": "xyz789" } ``` -### AddReturnCommentInput +### CartUserInputError -Defines a return comment. +An error encountered while adding an item to the the cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String!`](#string) | The text added to the return request. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json -{"comment_text": "xyz789", "return_uid": 4} +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" +} ``` -### AddReturnCommentOutput - -Contains details about the return request. +### CartUserInputErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | +| `PERMISSION_DENIED` | | #### Example ```json -{"return": Return} +""PRODUCT_NOT_FOUND"" ``` -### AddReturnTrackingInput +### CategoryFilterInput -Defines tracking information to be added to the return. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | #### Example ```json { - "carrier_uid": 4, - "return_uid": 4, - "tracking_number": "abc123" + "category_uid": FilterEqualTypeInput, + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput, + "parent_category_uid": FilterEqualTypeInput, + "parent_id": FilterEqualTypeInput, + "url_key": FilterEqualTypeInput, + "url_path": FilterEqualTypeInput } ``` -### AddReturnTrackingOutput +### CategoryInterface -Contains the response after adding tracking information. +Contains the full set of attributes that can be returned in a category search. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | + +#### Possible Types + +| CategoryInterface Types | +|----------------| +| [`CategoryTree`](#categorytree) | #### Example ```json { - "return": Return, - "return_shipping_tracking": ReturnShippingTracking + "automatic_sorting": "abc123", + "available_sort_by": ["abc123"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "abc123", + "children_count": "abc123", + "cms_block": CmsBlock, + "created_at": "abc123", + "custom_layout_update_file": "abc123", + "default_sort_by": "abc123", + "description": "xyz789", + "display_mode": "xyz789", + "filter_price_range": 123.45, + "id": 987, + "image": "xyz789", + "include_in_menu": 123, + "is_anchor": 123, + "landing_page": 987, + "level": 987, + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", + "name": "xyz789", + "path": "abc123", + "path_in_store": "abc123", + "position": 987, + "product_count": 987, + "products": CategoryProducts, + "staged": false, + "uid": "4", + "updated_at": "abc123", + "url_key": "xyz789", + "url_path": "abc123", + "url_suffix": "abc123" } ``` -### AddSimpleProductsToCartInput +### CategoryProducts -Defines the simple and group products to add to the cart. +Contains details about the products assigned to a category. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#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 ```json { - "cart_id": "xyz789", - "cart_items": [SimpleProductCartItemInput] + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### AddSimpleProductsToCartOutput +### CategoryResult -Contains details about the cart after adding simple or group products. +Contains a collection of `CategoryTree` objects and pagination information. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | #### Example ```json -{"cart": Cart} +{ + "items": [CategoryTree], + "page_info": SearchResultPageInfo, + "total_count": 987 +} ``` -### AddVirtualProductsToCartInput +### CategoryTree -Defines the virtual products to add to the cart. +Contains the hierarchy of categories. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | +| Field Name | Description | +|------------|-------------| +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | +| `children_count` - [`String`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "cart_id": "abc123", - "cart_items": [VirtualProductCartItemInput] + "automatic_sorting": "abc123", + "available_sort_by": ["xyz789"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "xyz789", + "children": [CategoryTree], + "children_count": "abc123", + "cms_block": CmsBlock, + "created_at": "xyz789", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", + "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": 123, + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "name": "abc123", + "path": "xyz789", + "path_in_store": "abc123", + "position": 123, + "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": "xyz789" } ``` -### AddVirtualProductsToCartOutput +### CheckoutAgreement -Contains details about the cart after adding virtual products. +Defines details about an individual checkout agreement. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](#string) | Required. The text of the agreement. | +| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | +| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | +| `name` - [`String!`](#string) | The name given to the condition. | #### Example ```json -{"cart": Cart} +{ + "agreement_id": 123, + "checkbox_text": "abc123", + "content": "xyz789", + "content_height": "abc123", + "is_html": false, + "mode": "AUTO", + "name": "xyz789" +} ``` -### AddWishlistItemsToCartOutput +### CheckoutAgreementMode -Contains the resultant wish list and any error information. +Indicates how agreements are accepted. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `AUTO` | Conditions are automatically accepted upon checkout. | +| `MANUAL` | Shoppers must manually accept the conditions to place an order. | #### Example ```json -{ - "add_wishlist_items_to_cart_user_errors": [ - WishlistCartUserInputError - ], - "status": false, - "wishlist": Wishlist -} +""AUTO"" ``` -### Aggregation +### CheckoutUserInputError -Contains information for each filterable option (such as price, category `UID`, and custom attributes). +An error encountered while adding an item to the cart. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](#int) | The number of options in the aggregation group. | -| `label` - [`String`](#string) | The aggregation display name. | -| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | - +| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | +| `message` - [`String!`](#string) | A localized error message. | +| `path` - [`[String]!`](#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 ```json { - "attribute_code": "abc123", - "count": 987, - "label": "abc123", - "options": [AggregationOption], - "position": 123 + "code": "REORDER_NOT_AVAILABLE", + "message": "abc123", + "path": ["xyz789"] } ``` -### AggregationOption - -An implementation of `AggregationOptionInterface`. +### CheckoutUserInputErrorCodes -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | +| `REORDER_NOT_AVAILABLE` | | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | #### Example ```json -{ - "count": 987, - "label": "abc123", - "value": "xyz789" -} +""REORDER_NOT_AVAILABLE"" ``` -### AggregationOptionInterface +### ClearCustomerCartOutput -Defines aggregation option fields. +Output of the request to clear the customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | - -#### Possible Types - -| AggregationOptionInterface Types | -|----------------| -| [`AggregationOption`](#aggregationoption) | +| `cart` - [`Cart`](#cart) | The cart after clearing items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | #### Example ```json -{ - "count": 987, - "label": "xyz789", - "value": "abc123" -} +{"cart": Cart, "status": false} ``` -### AggregationsCategoryFilterInput - -Filter category aggregations in layered navigation. +### CloseNegotiableQuoteError -#### Input Fields +#### Types -| Input Field | Description | -|-------------|-------------| -| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | #### Example ```json -{"includeDirectChildrenOnly": false} +NegotiableQuoteInvalidStateError ``` -### AggregationsFilterInput +### CloseNegotiableQuoteOperationFailure -An input object that specifies the filters used in product aggregations. +Contains details about a failed close operation on a negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | +| Field Name | Description | +|------------|-------------| +| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"category": AggregationsCategoryFilterInput} +{ + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": "4" +} ``` -### AppliedCoupon - -Contains the applied coupon code. +### CloseNegotiableQuoteOperationResult -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example ```json -{"code": "abc123"} +NegotiableQuoteUidOperationSuccess ``` -### AppliedGiftCard +### CloseNegotiableQuotesInput -Contains an applied gift card with applied and remaining balance. +Defines the negotiable quotes to mark as closed. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | -| `code` - [`String`](#string) | The gift card account code. | -| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | +| Input Field | Description | +|-------------|-------------| +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{ - "applied_balance": Money, - "code": "abc123", - "current_balance": Money, - "expiration_date": "abc123" -} +{"quote_uids": [4]} ``` -### AppliedStoreCredit +### CloseNegotiableQuotesOutput -Contains the applied and current balances. +Contains the closed negotiable quotes and other negotiable quotes the company user can view. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | +| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example ```json { - "applied_balance": Money, - "current_balance": Money, - "enabled": true + "closed_quotes": [NegotiableQuote], + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" } ``` -### ApplyCouponToCartInput +### CmsBlock -Specifies the coupon code to apply to the cart. +Contains details about a specific CMS block. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| Field Name | Description | +|------------|-------------| +| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](#string) | The CMS block identifier. | +| `title` - [`String`](#string) | The title assigned to the CMS block. | #### Example ```json { - "cart_id": "abc123", - "coupon_code": "abc123" + "content": "abc123", + "identifier": "abc123", + "title": "abc123" } ``` -### ApplyCouponToCartOutput +### CmsBlocks -Contains details about the cart after applying a coupon. +Contains an array CMS block items. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | #### Example ```json -{"cart": Cart} +{"items": [CmsBlock]} ``` -### ApplyGiftCardToCartInput +### CmsPage -Defines the input required to run the `applyGiftCardToCart` mutation. +Contains details about a CMS page. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | +| Field Name | Description | +|------------|-------------| +| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](#string) | The ID of a CMS page. | +| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { - "cart_id": "abc123", - "gift_card_code": "abc123" + "content": "abc123", + "content_heading": "abc123", + "identifier": "xyz789", + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "abc123", + "page_layout": "abc123", + "redirect_code": 987, + "relative_url": "abc123", + "title": "xyz789", + "type": "CMS_PAGE", + "url_key": "abc123" } ``` -### ApplyGiftCardToCartOutput - -Defines the possible output for the `applyGiftCardToCart` mutation. +### ColorSwatchData #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"cart": Cart} +{"value": "abc123"} ``` -### ApplyRewardPointsToCartOutput +### Company -Contains the customer cart. +Contains the output schema for a company. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | +| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | +| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | +| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | +| `email` - [`String`](#string) | The email address of the company contact. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | +| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | +| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | +| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | +| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | +| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | +| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json -{"cart": Cart} +{ + "acl_resources": [CompanyAclResource], + "company_admin": Customer, + "credit": CompanyCredit, + "credit_history": CompanyCreditHistory, + "email": "abc123", + "id": 4, + "legal_address": CompanyLegalAddress, + "legal_name": "xyz789", + "name": "xyz789", + "payment_methods": ["abc123"], + "reseller_id": "xyz789", + "role": CompanyRole, + "roles": CompanyRoles, + "sales_representative": CompanySalesRepresentative, + "structure": CompanyStructure, + "team": CompanyTeam, + "user": Customer, + "users": CompanyUsers, + "vat_tax_id": "xyz789" +} ``` -### ApplyStoreCreditToCartInput +### CompanyAclResource -Defines the input required to run the `applyStoreCreditToCart` mutation. +Contains details about the access control list settings of a resource. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| Field Name | Description | +|------------|-------------| +| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | +| `text` - [`String`](#string) | The label assigned to the ACL resource. | #### Example ```json -{"cart_id": "abc123"} +{ + "children": [CompanyAclResource], + "id": "4", + "sort_order": 123, + "text": "xyz789" +} ``` -### ApplyStoreCreditToCartOutput +### CompanyAdminInput -Defines the possible output for the `applyStoreCreditToCart` mutation. +Defines the input schema for creating a company administrator. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the company administrator. | +| `firstname` - [`String!`](#string) | The company administrator's first name. | +| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](#string) | The job title of the company administrator. | +| `lastname` - [`String!`](#string) | The company administrator's last name. | #### Example ```json -{"cart": Cart} +{ + "email": "abc123", + "firstname": "abc123", + "gender": 987, + "job_title": "abc123", + "lastname": "abc123" +} ``` -### AreaInput +### CompanyCreateInput -AreaInput defines the parameters which will be used for filter by specified location. +Defines the input schema for creating a new company. #### Input Fields | Input Field | Description | |-------------|-------------| -| `radius` - [`Int!`](#int) | The radius for the search in KM. | -| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | +| `company_email` - [`String!`](#string) | The email address of the company contact. | +| `company_name` - [`String!`](#string) | The name of the company to create. | +| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json -{"radius": 123, "search_term": "abc123"} +{ + "company_admin": CompanyAdminInput, + "company_email": "abc123", + "company_name": "xyz789", + "legal_address": CompanyLegalAddressCreateInput, + "legal_name": "xyz789", + "reseller_id": "abc123", + "vat_tax_id": "xyz789" +} ``` -### AssignCompareListToCustomerOutput +### CompanyCredit -Contains the results of the request to assign a compare list. +Contains company credit balances and limits. #### Fields | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | +| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](#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 ```json -{"compare_list": CompareList, "result": false} +{ + "available_credit": Money, + "credit_limit": Money, + "outstanding_balance": Money +} ``` -### Attribute +### CompanyCreditHistory -Contains details about the attribute, including the code and type. +Contains details about prior company credit operations. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | -| `attribute_type` - [`String`](#string) | The data type of the attribute. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | #### Example ```json { - "attribute_code": "abc123", - "attribute_options": [AttributeOption], - "attribute_type": "abc123", - "entity_type": "xyz789", - "input_type": "xyz789", - "storefront_properties": StorefrontProperties + "items": [CompanyCreditOperation], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### AttributeInput +### CompanyCreditHistoryFilterInput -Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. +Defines a filter for narrowing the results of a credit history search. #### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "attribute_code": "xyz789", - "entity_type": "xyz789" + "custom_reference_number": "xyz789", + "operation_type": "ALLOCATION", + "updated_by": "xyz789" } ``` -### AttributeOption +### CompanyCreditOperation -Defines an attribute option. +Contains details about a single company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](#string) | The date the operation occurred. | +| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | #### Example ```json { - "label": "xyz789", - "value": "xyz789" + "amount": Money, + "balance": CompanyCredit, + "custom_reference_number": "xyz789", + "date": "xyz789", + "type": "ALLOCATION", + "updated_by": CompanyCreditOperationUser } ``` -### AvailableCurrency - -Defines the code and symbol of a currency that can be used for purchase orders. +### CompanyCreditOperationType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `ALLOCATION` | | +| `UPDATE` | | +| `PURCHASE` | | +| `REIMBURSEMENT` | | +| `REFUND` | | +| `REVERT` | | #### Example ```json -{"code": "AFN", "symbol": "abc123"} +""ALLOCATION"" ``` -### AvailablePaymentMethod +### CompanyCreditOperationUser -Describes a payment method that the shopper can use to pay for the order. +Defines the administrator or company user that submitted a company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | #### Example ```json -{ - "code": "abc123", - "is_deferred": false, - "title": "abc123" -} +{"name": "abc123", "type": "CUSTOMER"} ``` -### AvailableShippingMethod - -Contains details about the possible shipping methods and carriers. +### CompanyCreditOperationUserType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `error_message` - [`String`](#string) | Describes an error condition. | -| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| `CUSTOMER` | | +| `ADMIN` | | #### Example ```json -{ - "amount": Money, - "available": false, - "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "abc123", - "error_message": "xyz789", - "method_code": "xyz789", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money -} +""CUSTOMER"" ``` -### BatchMutationStatus +### CompanyLegalAddress + +Contains details about the address where the company is registered to conduct business. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `SUCCESS` | | -| `FAILURE` | | -| `MIXED_RESULTS` | | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | +| `postcode` - [`String`](#string) | The company's postal code. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | +| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](#string) | The company's phone number. | #### Example ```json -""SUCCESS"" +{ + "city": "xyz789", + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegion, + "street": ["abc123"], + "telephone": "xyz789" +} ``` -### BillingAddressInput +### CompanyLegalAddressCreateInput -Defines the billing address. +Defines the input schema for defining a company's legal address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | -| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | +| `postcode` - [`String!`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](#string) | The primary phone number of the company. | #### Example ```json { - "address": CartAddressInput, - "customer_address_id": 987, - "same_as_shipping": true, - "use_for_shipping": false + "city": "abc123", + "country_id": "AF", + "postcode": "abc123", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "telephone": "xyz789" } ``` -### BillingCartAddress +### CompanyLegalAddressUpdateInput -Contains details about the billing address. +Defines the input schema for updating a company's legal address. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | +| `postcode` - [`String`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](#string) | The primary phone number of the company. | #### Example ```json { - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "customer_notes": "abc123", - "firstname": "xyz789", - "lastname": "xyz789", + "city": "abc123", + "country_id": "AF", "postcode": "abc123", - "region": CartAddressRegion, + "region": CustomerAddressRegionInput, "street": ["abc123"], - "telephone": "abc123", - "uid": "abc123", - "vat_id": "abc123" + "telephone": "abc123" } ``` -### Boolean - -The `Boolean` scalar type represents `true` or `false`. - - +### CompanyRole -### BraintreeCcVaultInput +Contails details about a single role. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name assigned to the role. | +| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | +| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | #### Example ```json { - "device_data": "abc123", - "public_hash": "xyz789" + "id": 4, + "name": "xyz789", + "permissions": [CompanyAclResource], + "users_count": 123 } ``` -### BraintreeInput +### CompanyRoleCreateInput + +Defines the input schema for creating a company role. #### Input Fields | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#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!`](#boolean) | States whether an entered by a customer credit/debit card should be tokenized for later usage. Required only if Vault is enabled for Braintree payment integration. | -| `payment_method_nonce` - [`String!`](#string) | The one-time payment token generated by Braintree payment gateway based on card details. Required field to make sale transaction. | +| `name` - [`String!`](#string) | The name of the role to create. | +| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | #### Example ```json { - "device_data": "abc123", - "is_active_payment_token_enabler": true, - "payment_method_nonce": "xyz789" + "name": "xyz789", + "permissions": ["xyz789"] } ``` -### Breadcrumb +### CompanyRoleUpdateInput -Contains details about an individual category that comprises a breadcrumb. +Defines the input schema for updating a company role. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](#int) | The category level. | -| `category_name` - [`String`](#string) | The display name of the category. | -| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](#string) | The URL key of the category. | -| `category_url_path` - [`String`](#string) | The URL path of the category. | +| Input Field | Description | +|-------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name of the role to update. | +| `permissions` - [`[String]`](#string) | A list of resources the role can access. | #### Example ```json { - "category_id": 987, - "category_level": 987, - "category_name": "abc123", - "category_uid": 4, - "category_url_key": "xyz789", - "category_url_path": "xyz789" + "id": "4", + "name": "abc123", + "permissions": ["abc123"] } ``` -### BundleCartItem +### CompanyRoles -An implementation for bundle product cart items. +Contains an array of roles. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "xyz789", - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "items": [CompanyRole], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### BundleCreditMemoItem +### CompanySalesRepresentative -Defines bundle product options for `CreditMemoItemInterface`. +Contains details about a company sales representative. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `email` - [`String`](#string) | The email address of the company sales representative. | +| `firstname` - [`String`](#string) | The company sales representative's first name. | +| `lastname` - [`String`](#string) | The company sales representative's last name. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 + "email": "abc123", + "firstname": "xyz789", + "lastname": "abc123" } ``` -### BundleInvoiceItem +### CompanyStructure -Defines bundle product options for `InvoiceItemInterface`. +Contains an array of the individual nodes that comprise the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | #### Example ```json -{ - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 -} +{"items": [CompanyStructureItem]} ``` -### BundleItem - -Defines an individual item within a bundle product. +### CompanyStructureEntity -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | -| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | -| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](#string) | The SKU of the bundle product. | -| `title` - [`String`](#string) | The display name of the item. | -| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | +| Union Types | +|-------------| +| [`CompanyTeam`](#companyteam) | +| [`Customer`](#customer) | #### Example ```json -{ - "option_id": 987, - "options": [BundleItemOption], - "position": 987, - "price_range": PriceRange, - "required": true, - "sku": "abc123", - "title": "xyz789", - "type": "xyz789", - "uid": 4 -} +CompanyTeam ``` -### BundleItemOption +### CompanyStructureItem -Defines the characteristics that comprise a specific bundle item and its options. +Defines an individual node in the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | -| `label` - [`String`](#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | +| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | #### Example ```json -{ - "can_change_quantity": false, - "id": 123, - "is_default": false, - "label": "xyz789", - "position": 987, - "price": 123.45, - "price_type": "FIXED", - "product": ProductInterface, - "qty": 123.45, - "quantity": 987.65, - "uid": 4 -} +{"entity": CompanyTeam, "id": 4, "parent_id": 4} ``` -### BundleOptionInput +### CompanyStructureUpdateInput -Defines the input for a bundle option. +Defines the input schema for updating the company structure. #### Input Fields | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](#int) | The ID of the option. | -| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | +| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{ - "id": 987, - "quantity": 987.65, - "value": ["xyz789"] -} +{"parent_tree_id": 4, "tree_id": "4"} ``` -### BundleOrderItem +### CompanyTeam -Defines bundle product options for `OrderItemInterface`. +Describes a company team. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](#string) | The display name of the team. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, + "description": "xyz789", "id": "4", - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "abc123" + "name": "abc123", + "structure_id": "4" } ``` -### BundleProduct +### CompanyTeamCreateInput -Defines basic features of a bundle product and contains multiple BundleItems. +Defines the input schema for creating a company team. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | -| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | -| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `name` - [`String!`](#string) | The display name of the team. | +| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", - "collar": "abc123", - "color": 987, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "dynamic_price": false, - "dynamic_sku": true, - "dynamic_weight": true, - "eco_collection": 123, - "erin_recommends": 123, - "features_bags": "abc123", - "format": 123, - "gender": "abc123", - "gift_message_available": "abc123", - "id": 987, - "image": ProductImage, - "is_returnable": "xyz789", - "items": [BundleItem], - "manufacturer": 123, - "material": "abc123", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", + "description": "abc123", "name": "xyz789", - "new": 987, - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 987, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "price_view": "PRICE_RANGE", - "product_links": [ProductLinksInterface], - "purpose": 123, - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, - "reviews": ProductReviews, - "sale": 987, - "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": "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": 123.45, - "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], - "weight": 987.65 + "target_id": "4" } ``` -### BundleProductCartItemInput +### CompanyTeamUpdateInput -Defines a single bundle product. +Defines the input schema for updating a company team. #### Input Fields | Input Field | Description | |-------------|-------------| -| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](#string) | The display name of the team. | #### Example ```json { - "bundle_options": [BundleOptionInput], - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput + "description": "xyz789", + "id": "4", + "name": "xyz789" } ``` -### BundleRequisitionListItem +### CompanyUpdateInput -Contains details about bundle products added to a requisition list. +Defines the input schema for updating a company. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| Input Field | Description | +|-------------|-------------| +| `company_email` - [`String`](#string) | The email address of the company contact. | +| `company_name` - [`String`](#string) | The name of the company to update. | +| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "company_email": "abc123", + "company_name": "abc123", + "legal_address": CompanyLegalAddressUpdateInput, + "legal_name": "abc123", + "reseller_id": "xyz789", + "vat_tax_id": "xyz789" } ``` -### BundleShipmentItem +### CompanyUserCreateInput -Defines bundle product options for `ShipmentItemInterface`. +Defines the input schema for creating a company user. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The company user's email address | +| `firstname` - [`String!`](#string) | The company user's first name. | +| `job_title` - [`String!`](#string) | The company user's job title or function. | +| `lastname` - [`String!`](#string) | The company user's last name. | +| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `target_id` - [`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!`](#string) | The company user's phone number. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 123.45 + "email": "xyz789", + "firstname": "xyz789", + "job_title": "abc123", + "lastname": "xyz789", + "role_id": "4", + "status": "ACTIVE", + "target_id": 4, + "telephone": "abc123" } ``` -### BundleWishlistItem +### CompanyUserStatusEnum -Defines bundle product options for `WishlistItemInterface`. +Defines the list of company user status values. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `ACTIVE` | Only active users. | +| `INACTIVE` | Only inactive users. | #### Example ```json -{ - "added_at": "xyz789", - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 -} +""ACTIVE"" ``` -### Cart +### CompanyUserUpdateInput -Contains the contents and other details about a guest or customer cart. +Defines the input schema for updating a company user. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. | -| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | +| Input Field | Description | +|-------------|-------------| +| `email` - [`String`](#string) | The company user's email address. | +| `firstname` - [`String`](#string) | The company user's first name. | +| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](#string) | The company user's job title or function. | +| `lastname` - [`String`](#string) | The company user's last name. | +| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The company user's phone number. | #### Example ```json { - "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": false, - "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, - "items": [CartItemInterface], - "prices": CartPrices, - "printed_card_included": false, - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "firstname": "xyz789", + "id": 4, + "job_title": "xyz789", + "lastname": "abc123", + "role_id": "4", + "status": "ACTIVE", + "telephone": "abc123" } ``` -### CartAddressCountry +### CompanyUsers -Contains details the country in a billing or shipping address. +Contains details about company users. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The number of objects returned. | #### Example ```json { - "code": "xyz789", - "label": "xyz789" + "items": [Customer], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### CartAddressInput +### CompanyUsersFilterInput -Defines the billing or shipping address to be applied to the cart. +Defines the filter for returning a list of company users. #### Input Fields | Input Field | Description | |-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | #### Example ```json -{ - "city": "abc123", - "company": "abc123", - "country_code": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "postcode": "abc123", - "region": "xyz789", - "region_id": 987, - "save_in_address_book": false, - "street": ["xyz789"], - "telephone": "xyz789", - "vat_id": "abc123" -} +{"status": "ACTIVE"} ``` -### CartAddressInterface +### ComparableAttribute + +Contains an attribute code that is used for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | - -#### Possible Types - -| CartAddressInterface Types | -|----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](#string) | The label of the attribute code. | #### Example ```json { - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "firstname": "abc123", - "lastname": "abc123", - "postcode": "abc123", - "region": CartAddressRegion, - "street": ["xyz789"], - "telephone": "abc123", - "uid": "xyz789", - "vat_id": "xyz789" + "code": "abc123", + "label": "abc123" } ``` -### CartAddressRegion +### ComparableItem -Contains details about the region in a billing or shipping address. +Defines an object used to iterate through items for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The state or province code. | -| `label` - [`String`](#string) | The display label for the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | #### Example ```json { - "code": "xyz789", - "label": "xyz789", - "region_id": 123 + "attributes": [ProductAttribute], + "product": ProductInterface, + "uid": "4" } ``` -### CartDiscount +### CompareList -Contains information about discounts applied to the cart. +Contains iterable information such as the array of items, the count, and attributes that represent the compare list. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | +| `item_count` - [`Int!`](#int) | The number of items in the compare list. | +| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | #### Example ```json { - "amount": Money, - "label": ["abc123"] + "attributes": [ComparableAttribute], + "item_count": 123, + "items": [ComparableItem], + "uid": 4 } ``` -### CartItemError +### ComplexTextValue #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | - -#### Example - -```json -{"code": "UNDEFINED", "message": "xyz789"} -``` - - - -### CartItemErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `ITEM_QTY` | | -| `ITEM_INCREMENTS` | | +| `html` - [`String!`](#string) | Text that can contain HTML tags. | #### Example ```json -""UNDEFINED"" +{"html": "xyz789"} ``` -### CartItemInput +### ConfigurableAttributeOption -Defines an item to be added to the cart. +Contains details about a configurable product attribute option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The ID assigned to the attribute. | +| `label` - [`String`](#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 987.65, - "selected_options": ["4"], - "sku": "abc123" + "code": "abc123", + "label": "abc123", + "uid": "4", + "value_index": 987 } ``` -### CartItemInterface +### ConfigurableCartItem -An interface for products in a cart. +An implementation for configurable product cart items. #### Fields | Field Name | Description | |------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | | `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Possible Types - -| CartItemInterface Types | -|----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | -| [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | -| [`ConfigurableCartItem`](#configurablecartitem) | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { + "available_gift_wrapping": [GiftWrapping], + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], "errors": [CartItemError], - "id": "xyz789", + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "abc123", "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` -### CartItemPrices +### ConfigurableOptionAvailableForSelection -Contains details about the price of the item, including taxes and discounts. +Describes configurable options that have been selected and can be selected as a result of the previous selections. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | -| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | #### Example ```json { - "discounts": [Discount], - "fixed_product_taxes": [FixedProductTax], - "price": Money, - "price_including_tax": Money, - "row_total": Money, - "row_total_including_tax": Money, - "total_item_discount": Money + "attribute_code": "xyz789", + "option_value_uids": ["4"] } ``` -### CartItemQuantity +### ConfigurableProduct -Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. +Defines basic features of a configurable product and its simple product variants. #### Fields | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | - -#### Example - -```json -{"cart_item_id": 123, "quantity": 987.65} -``` - - - -### CartItemSelectedOptionValuePrice - -Contains details about the price of a selected customizable value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](#float) | A price value. | +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | +| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "type": "FIXED", - "units": "abc123", - "value": 987.65 + "activity": "xyz789", + "attribute_set_id": 123, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "abc123", + "collar": "xyz789", + "color": 123, + "configurable_options": [ConfigurableProductOptions], + "configurable_product_options_selection": ConfigurableProductOptionsSelection, + "country_of_manufacture": "abc123", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "eco_collection": 123, + "erin_recommends": 987, + "features_bags": "xyz789", + "format": 987, + "gender": "xyz789", + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 123, + "material": "abc123", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "pattern": "abc123", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 123, + "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": "abc123", + "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": "xyz789", + "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 } ``` -### CartItemUpdateInput - -A single item to be updated. +### ConfigurableProductCartItemInput #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | +| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](#string) | Deprecated. Use `CartItemInput.sku` instead. | #### Example ```json { - "cart_item_id": 987, - "cart_item_uid": "4", "customizable_options": [CustomizableOptionInput], - "gift_message": GiftMessageInput, - "gift_wrapping_id": "4", - "quantity": 123.45 + "data": CartItemInput, + "parent_sku": "xyz789", + "variant_sku": "xyz789" } ``` -### CartPrices +### ConfigurableProductOption -Contains details about the final price of items in the cart, including discount and tax information. +Contains details about configurable product options. #### Fields | Field Name | Description | |------------|-------------| -| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | -| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | -| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](#string) | The display name of the option. | +| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | +| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example ```json { - "applied_taxes": [CartTaxItem], - "discount": CartDiscount, - "discounts": [Discount], - "gift_options": GiftOptionsPrices, - "grand_total": Money, - "subtotal_excluding_tax": Money, - "subtotal_including_tax": Money, - "subtotal_with_discount_excluding_tax": Money + "attribute_code": "xyz789", + "label": "abc123", + "uid": 4, + "values": [ConfigurableProductOptionValue] } ``` -### CartTaxItem +### ConfigurableProductOptionValue -Contains tax information about an item in the cart. +Defines a value for a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](#id) | The unique ID of the value. | #### Example ```json { - "amount": Money, - "label": "xyz789" + "is_available": true, + "is_use_default": true, + "label": "abc123", + "swatch": SwatchDataInterface, + "uid": 4 } ``` -### CartUserInputError +### ConfigurableProductOptions -An error encountered while adding an item to the the cart. +Defines configurable attributes for the specified product. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | +| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | #### Example ```json { - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "attribute_code": "xyz789", + "attribute_id": "xyz789", + "attribute_id_v2": 123, + "attribute_uid": 4, + "id": 123, + "label": "xyz789", + "position": 123, + "product_id": 123, + "uid": "4", + "use_default": true, + "values": [ConfigurableProductOptionsValues] } ``` -### CartUserInputErrorType +### ConfigurableProductOptionsSelection -#### Values +Contains metadata corresponding to the selected configurable options. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | -| `PERMISSION_DENIED` | | +| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | +| `variant` - [`SimpleProduct`](#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 ```json -""PRODUCT_NOT_FOUND"" +{ + "configurable_options": [ConfigurableProductOption], + "media_gallery": [MediaGalleryInterface], + "options_available_for_selection": [ + ConfigurableOptionAvailableForSelection + ], + "variant": SimpleProduct +} ``` -### CategoryFilterInput +### ConfigurableProductOptionsValues -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. +Contains the index number assigned to a configurable product option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | +| Field Name | Description | +|------------|-------------| +| `default_label` - [`String`](#string) | The label of the product on the default store. | +| `label` - [`String`](#string) | The label of the product. | +| `store_label` - [`String`](#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "category_uid": FilterEqualTypeInput, - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput, - "parent_category_uid": FilterEqualTypeInput, - "parent_id": FilterEqualTypeInput, - "url_key": FilterEqualTypeInput, - "url_path": FilterEqualTypeInput + "default_label": "abc123", + "label": "abc123", + "store_label": "abc123", + "swatch_data": SwatchDataInterface, + "uid": 4, + "use_default_value": false, + "value_index": 987 } ``` -### CategoryInterface +### ConfigurableRequisitionListItem -Contains the full set of attributes that can be returned in a category search. +Contains details about configurable products added to a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | - -#### Possible Types - -| CategoryInterface Types | -|----------------| -| [`CategoryTree`](#categorytree) | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json { - "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "xyz789", - "cms_block": CmsBlock, - "created_at": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", - "description": "xyz789", - "display_mode": "xyz789", - "filter_price_range": 123.45, - "id": 987, - "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 987, - "level": 123, - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "xyz789", - "path": "xyz789", - "path_in_store": "abc123", - "position": 123, - "product_count": 123, - "products": CategoryProducts, - "staged": true, - "uid": 4, - "updated_at": "abc123", - "url_key": "xyz789", - "url_path": "abc123", - "url_suffix": "xyz789" + "configurable_options": [SelectedConfigurableOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 } ``` -### CategoryProducts +### ConfigurableVariant -Contains details about the products assigned to a category. +Contains all the simple product variants of a configurable product. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#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. | +| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | +| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | #### Example ```json { - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "total_count": 123 + "attributes": [ConfigurableAttributeOption], + "product": SimpleProduct } ``` -### CategoryResult +### ConfigurableWishlistItem -Contains a collection of `CategoryTree` objects and pagination information. +A configurable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "items": [CategoryTree], - "page_info": SearchResultPageInfo, - "total_count": 123 + "added_at": "xyz789", + "child_sku": "xyz789", + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 } ``` -### CategoryTree +### CopyItemsBetweenRequisitionListsInput -Contains the hierarchy of categories. +An input object that defines the items in a requisition list to be copied. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | -| `children_count` - [`String`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | +| Input Field | Description | +|-------------|-------------| +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{ - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children": [CategoryTree], - "children_count": "abc123", - "cms_block": CmsBlock, - "created_at": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", - "description": "abc123", - "display_mode": "abc123", - "filter_price_range": 987.65, - "id": 987, - "image": "xyz789", - "include_in_menu": 987, - "is_anchor": 987, - "landing_page": 987, - "level": 123, - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "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": "abc123", - "url_path": "abc123", - "url_suffix": "xyz789" -} +{"requisitionListItemUids": [4]} ``` -### CheckoutAgreement +### CopyItemsFromRequisitionListsOutput -Defines details about an individual checkout agreement. +Output of the request to copy items to the destination requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](#string) | Required. The text of the agreement. | -| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | -| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](#string) | The name given to the condition. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | #### Example ```json -{ - "agreement_id": 987, - "checkbox_text": "abc123", - "content": "xyz789", - "content_height": "xyz789", - "is_html": true, - "mode": "AUTO", - "name": "xyz789" -} +{"requisition_list": RequisitionList} ``` -### CheckoutAgreementMode +### CopyProductsBetweenWishlistsOutput -Indicates how agreements are accepted. +Contains the source and target wish lists after copying products. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `AUTO` | Conditions are automatically accepted upon checkout. | -| `MANUAL` | Shoppers must manually accept the conditions to place an order. | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example ```json -""AUTO"" +{ + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] +} ``` -### CheckoutUserInputError - -An error encountered while adding an item to the cart. +### Country #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](#string) | A localized error message. | -| `path` - [`[String]!`](#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 | +| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](#string) | The name of the country in English. | +| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | +| `id` - [`String`](#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { - "code": "REORDER_NOT_AVAILABLE", - "message": "xyz789", - "path": ["abc123"] -} + "available_regions": [Region], + "full_name_english": "abc123", + "full_name_locale": "xyz789", + "id": "xyz789", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "xyz789" +} ``` -### CheckoutUserInputErrorCodes +### CountryCodeEnum + +The list of country codes. #### Values | Enum Value | Description | |------------|-------------| -| `REORDER_NOT_AVAILABLE` | | -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | +| `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 | +| `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 | +| `SZ` | Swaziland | +| `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 ```json -""REORDER_NOT_AVAILABLE"" +""AF"" ``` -### ClearCustomerCartOutput +### CreateCompanyOutput -Output of the request to clear the customer cart. +Contains the response to the request to create a company. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `company` - [`Company!`](#company) | The new company instance. | #### Example ```json -{"cart": Cart, "status": false} +{"company": Company} ``` -### CloseNegotiableQuoteError +### CreateCompanyRoleOutput -#### Types +Contains the response to the request to create a company role. -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | #### Example ```json -NegotiableQuoteInvalidStateError +{"role": CompanyRole} ``` -### CloseNegotiableQuoteOperationFailure +### CreateCompanyTeamOutput -Contains details about a failed close operation on a negotiable quote. +Contains the response to the request to create a company team. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | #### Example ```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" -} +{"team": CompanyTeam} ``` -### CloseNegotiableQuoteOperationResult +### CreateCompanyUserOutput -#### Types +Contains the response to the request to create a company user. -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user` - [`Customer!`](#customer) | The new company user instance. | #### Example ```json -NegotiableQuoteUidOperationSuccess +{"user": Customer} ``` -### CloseNegotiableQuotesInput +### CreateCompareListInput -Defines the negotiable quotes to mark as closed. +Contains an array of product IDs to use for creating a compare list. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"quote_uids": ["4"]} +{"products": [4]} ``` -### CloseNegotiableQuotesOutput +### CreateGiftRegistryInput -Contains the closed negotiable quotes and other negotiable quotes the company user can view. +Defines a new gift registry. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | -| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | +| `message` - [`String!`](#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example ```json { - "closed_quotes": [NegotiableQuote], - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput ], - "result_status": "SUCCESS" + "event_name": "xyz789", + "gift_registry_type_uid": 4, + "message": "xyz789", + "privacy_settings": "PRIVATE", + "registrants": [AddGiftRegistryRegistrantInput], + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" } ``` -### CmsBlock +### CreateGiftRegistryOutput -Contains details about a specific CMS block. +Contains the results of a request to create a gift registry. #### Fields | Field Name | Description | |------------|-------------| -| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](#string) | The CMS block identifier. | -| `title` - [`String`](#string) | The title assigned to the CMS block. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | #### Example ```json -{ - "content": "abc123", - "identifier": "xyz789", - "title": "abc123" -} +{"gift_registry": GiftRegistry} ``` -### CmsBlocks +### CreatePayflowProTokenOutput -Contains an array CMS block items. +Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | +| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | #### Example ```json -{"items": [CmsBlock]} +{ + "response_message": "xyz789", + "result": 987, + "result_code": 987, + "secure_token": "abc123", + "secure_token_id": "abc123" +} ``` -### CmsPage +### CreateProductReviewInput -Contains details about a CMS page. +Defines a new product review. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](#string) | The ID of a CMS page. | -| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| Input Field | Description | +|-------------|-------------| +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json { - "content": "abc123", - "content_heading": "abc123", - "identifier": "xyz789", - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "page_layout": "xyz789", - "redirect_code": 123, - "relative_url": "xyz789", - "title": "xyz789", - "type": "CMS_PAGE", - "url_key": "xyz789" + "nickname": "xyz789", + "ratings": [ProductReviewRatingInput], + "sku": "xyz789", + "summary": "abc123", + "text": "xyz789" } ``` -### ColorSwatchData +### CreateProductReviewOutput + +Contains the completed product review. #### Fields | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `review` - [`ProductReview!`](#productreview) | Product review details. | #### Example ```json -{"value": "xyz789"} +{"review": ProductReview} ``` -### Company +### CreatePurchaseOrderApprovalRuleConditionAmountInput -Contains the output schema for a company. +Specifies the amount and currency to evaluate. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | -| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | -| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | -| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | -| `email` - [`String`](#string) | The email address of the company contact. | -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | -| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | -| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | -| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | -| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | -| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | -| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Input Field | Description | +|-------------|-------------| +| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | +| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | #### Example ```json -{ - "acl_resources": [CompanyAclResource], - "company_admin": Customer, - "credit": CompanyCredit, - "credit_history": CompanyCreditHistory, - "email": "xyz789", - "id": 4, - "legal_address": CompanyLegalAddress, - "legal_name": "abc123", - "name": "abc123", - "payment_methods": ["abc123"], - "reseller_id": "abc123", - "role": CompanyRole, - "roles": CompanyRoles, - "sales_representative": CompanySalesRepresentative, - "structure": CompanyStructure, - "team": CompanyTeam, - "user": Customer, - "users": CompanyUsers, - "vat_tax_id": "abc123" -} +{"currency": "AFN", "value": 987.65} ``` -### CompanyAclResource +### CreatePurchaseOrderApprovalRuleConditionInput -Contains details about the access control list settings of a resource. +Defines a set of conditions that apply to a rule. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | -| `text` - [`String`](#string) | The label assigned to the ACL resource. | +| Input Field | Description | +|-------------|-------------| +| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example ```json { - "children": [CompanyAclResource], - "id": 4, - "sort_order": 987, - "text": "xyz789" + "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN", + "quantity": 123 } ``` -### CompanyAdminInput +### CreateRequisitionListInput -Defines the input schema for creating a company administrator. +An input object that identifies and describes a new requisition list. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | The email address of the company administrator. | -| `firstname` - [`String!`](#string) | The company administrator's first name. | -| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](#string) | The job title of the company administrator. | -| `lastname` - [`String!`](#string) | The company administrator's last name. | +| `description` - [`String`](#string) | An optional description of the requisition list. | +| `name` - [`String!`](#string) | The name assigned to the requisition list. | #### Example ```json { - "email": "abc123", - "firstname": "xyz789", - "gender": 123, - "job_title": "abc123", - "lastname": "abc123" + "description": "abc123", + "name": "abc123" } ``` -### CompanyCreateInput +### CreateRequisitionListOutput -Defines the input schema for creating a new company. +Output of the request to create a requisition list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](#string) | The email address of the company contact. | -| `company_name` - [`String!`](#string) | The name of the company to create. | -| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | #### Example ```json -{ - "company_admin": CompanyAdminInput, - "company_email": "xyz789", - "company_name": "abc123", - "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", - "reseller_id": "xyz789", - "vat_tax_id": "abc123" -} +{"requisition_list": RequisitionList} ``` -### CompanyCredit +### CreateWishlistInput -Contains company credit balances and limits. +Defines the name and visibility of a new wish list. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](#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. | +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -{ - "available_credit": Money, - "credit_limit": Money, - "outstanding_balance": Money -} +{"name": "xyz789", "visibility": "PUBLIC"} ``` -### CompanyCreditHistory +### CreateWishlistOutput -Contains details about prior company credit operations. +Contains the wish list. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | +| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | #### Example ```json -{ - "items": [CompanyCreditOperation], - "page_info": SearchResultPageInfo, - "total_count": 987 -} +{"wishlist": Wishlist} ``` -### CompanyCreditHistoryFilterInput +### CreditCardDetailsInput -Defines a filter for narrowing the results of a credit history search. +Required fields for Payflow Pro and Payments Pro credit card payments. #### Input Fields | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | +| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](#string) | The credit card type. | #### Example ```json { - "custom_reference_number": "abc123", - "operation_type": "ALLOCATION", - "updated_by": "abc123" + "cc_exp_month": 123, + "cc_exp_year": 987, + "cc_last_4": 987, + "cc_type": "abc123" } ``` -### CompanyCreditOperation +### CreditMemo -Contains details about a single company credit operation. +Contains credit memo details. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | -| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](#string) | The date the operation occurred. | -| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | +| `number` - [`String!`](#string) | The sequential credit memo number. | +| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example ```json { - "amount": Money, - "balance": CompanyCredit, - "custom_reference_number": "xyz789", - "date": "xyz789", - "type": "ALLOCATION", - "updated_by": CompanyCreditOperationUser + "comments": [SalesCommentItem], + "id": 4, + "items": [CreditMemoItemInterface], + "number": "abc123", + "total": CreditMemoTotal } ``` -### CompanyCreditOperationType +### CreditMemoItem -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ALLOCATION` | | -| `UPDATE` | | -| `PURCHASE` | | -| `REIMBURSEMENT` | | -| `REFUND` | | -| `REVERT` | | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json -""ALLOCATION"" +{ + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 123.45 +} ``` -### CompanyCreditOperationUser +### CreditMemoItemInterface -Defines the administrator or company user that submitted a company credit operation. +Credit memo item details. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | -| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | - -#### Example - -```json -{"name": "xyz789", "type": "CUSTOMER"} -``` - - - -### CompanyCreditOperationUserType +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -#### Values +#### Possible Types -| Enum Value | Description | -|------------|-------------| -| `CUSTOMER` | | -| `ADMIN` | | +| CreditMemoItemInterface Types | +|----------------| +| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | +| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`CreditMemoItem`](#creditmemoitem) | #### Example ```json -""CUSTOMER"" +{ + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 +} ``` -### CompanyLegalAddress +### CreditMemoTotal -Contains details about the address where the company is registered to conduct business. +Contains credit memo price details. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | -| `postcode` - [`String`](#string) | The company's postal code. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](#string) | The company's phone number. | - -#### Example - -```json -{ - "city": "abc123", - "country_code": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegion, - "street": ["abc123"], - "telephone": "abc123" -} -``` - - - -### CompanyLegalAddressCreateInput - -Defines the input schema for defining a company's legal address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | -| `postcode` - [`String!`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](#string) | The primary phone number of the company. | +| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | #### Example ```json { - "city": "xyz789", - "country_id": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "xyz789" + "adjustment": Money, + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money } ``` -### CompanyLegalAddressUpdateInput - -Defines the input schema for updating a company's legal address. +### Currency -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](#string) | The primary phone number of the company. | +| Field Name | Description | +|------------|-------------| +| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | +| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | #### Example ```json { - "city": "xyz789", - "country_id": "AF", - "postcode": "abc123", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "xyz789" + "available_currency_codes": ["abc123"], + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", + "default_display_currecy_code": "xyz789", + "default_display_currecy_symbol": "xyz789", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "abc123", + "exchange_rates": [ExchangeRate] } ``` -### CompanyRole +### CurrencyEnum -Contails details about a single role. +The list of available currency codes. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | -| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | - -#### Example - -```json -{ - "id": 4, - "name": "abc123", - "permissions": [CompanyAclResource], - "users_count": 987 -} -``` - - - -### CompanyRoleCreateInput - -Defines the input schema for creating a company role. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| `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 ```json -{ - "name": "abc123", - "permissions": ["abc123"] -} +""AFN"" ``` -### CompanyRoleUpdateInput +### CustomAttributeMetadata -Defines the input schema for updating a company role. +Defines an array of custom attributes. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name of the role to update. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[Attribute]`](#attribute) | An array of attributes. | #### Example ```json -{ - "id": "4", - "name": "xyz789", - "permissions": ["abc123"] -} +{"items": [Attribute]} ``` -### CompanyRoles +### Customer -Contains an array of roles. +Defines the customer name, addresses, and other details. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | +| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](#string) | The customer's email address. Required. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | +| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](#int) | The ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `orders` - [`CustomerOrders`](#customerorders) | | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | +| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | +| `telephone` - [`String`](#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](#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. | #### Example ```json { - "items": [CompanyRole], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - + "addresses": [CustomerAddress], + "allow_remote_shopping_assistance": true, + "compare_list": CompareList, + "created_at": "xyz789", + "date_of_birth": "xyz789", + "default_billing": "xyz789", + "default_shipping": "xyz789", + "dob": "abc123", + "email": "xyz789", + "firstname": "xyz789", + "gender": 987, + "gift_registries": [GiftRegistry], + "gift_registry": GiftRegistry, + "group_id": 123, + "id": 987, + "is_subscribed": true, + "job_title": "abc123", + "lastname": "abc123", + "middlename": "abc123", + "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, + "status": "ACTIVE", + "store_credit": CustomerStoreCredit, + "structure_id": 4, + "suffix": "abc123", + "taxvat": "xyz789", + "team": CompanyTeam, + "telephone": "xyz789", + "wishlist": Wishlist, + "wishlist_v2": Wishlist, + "wishlists": [Wishlist] +} +``` -### CompanySalesRepresentative + -Contains details about a company sales representative. +### CustomerAddress + +Contains detailed information about a customer's billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String`](#string) | The email address of the company sales representative. | -| `firstname` - [`String`](#string) | The company sales representative's first name. | -| `lastname` - [`String`](#string) | The company sales representative's last name. | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Custom attributes should not be put into a container.)* | +| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | +| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "email": "abc123", + "city": "xyz789", + "company": "abc123", + "country_code": "AF", + "country_id": "xyz789", + "custom_attributes": [CustomerAddressAttribute], + "customer_id": 987, + "default_billing": false, + "default_shipping": false, + "extension_attributes": [CustomerAddressAttribute], + "fax": "xyz789", "firstname": "abc123", - "lastname": "abc123" + "id": 987, + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": CustomerAddressRegion, + "region_id": 123, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "xyz789" } ``` -### CompanyStructure +### CustomerAddressAttribute -Contains an array of the individual nodes that comprise the company structure. +Specifies the attribute code and value of a customer address attribute. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | - -#### Example - -```json -{"items": [CompanyStructureItem]} -``` - - - -### CompanyStructureEntity - -#### Types - -| Union Types | -|-------------| -| [`CompanyTeam`](#companyteam) | -| [`Customer`](#customer) | +| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](#string) | The valuue assigned to the customer address attribute. | #### Example ```json -CompanyTeam +{ + "attribute_code": "xyz789", + "value": "abc123" +} ``` -### CompanyStructureItem +### CustomerAddressAttributeInput -Defines an individual node in the company structure. +Specifies the attribute code and value of a customer attribute. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | +| `value` - [`String!`](#string) | The value assigned to the attribute. | #### Example ```json { - "entity": CompanyTeam, - "id": "4", - "parent_id": "4" + "attribute_code": "xyz789", + "value": "abc123" } ``` -### CompanyStructureUpdateInput +### CustomerAddressInput -Defines the input schema for updating the company structure. +Contains details about a billing or shipping address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | Deprecated: use `country_code` instead. | +| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | Deprecated: Custom attributes should not be put into container. | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json -{"parent_tree_id": 4, "tree_id": "4"} +{ + "city": "abc123", + "company": "abc123", + "country_code": "AF", + "country_id": "AF", + "custom_attributes": [CustomerAddressAttributeInput], + "default_billing": false, + "default_shipping": false, + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "abc123" +} ``` -### CompanyTeam +### CustomerAddressRegion -Describes a company team. +Defines the customer's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](#string) | The display name of the team. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "description": "abc123", - "id": "4", - "name": "xyz789", - "structure_id": 4 + "region": "abc123", + "region_code": "xyz789", + "region_id": 987 } ``` -### CompanyTeamCreateInput +### CustomerAddressRegionInput -Defines the input schema for creating a company team. +Defines the customer's state or province. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `name` - [`String!`](#string) | The display name of the team. | -| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "description": "xyz789", - "name": "abc123", - "target_id": 4 + "region": "abc123", + "region_code": "xyz789", + "region_id": 123 } ``` -### CompanyTeamUpdateInput +### CustomerCreateInput -Defines the input schema for updating a company team. +An input object for creating a customer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](#string) | The display name of the team. | +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String!`](#string) | The customer's email address. | +| `firstname` - [`String!`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "description": "abc123", - "id": "4", - "name": "xyz789" + "allow_remote_shopping_assistance": false, + "date_of_birth": "abc123", + "dob": "abc123", + "email": "abc123", + "firstname": "xyz789", + "gender": 123, + "is_subscribed": false, + "lastname": "xyz789", + "middlename": "abc123", + "password": "abc123", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "abc123" } ``` -### CompanyUpdateInput +### CustomerDownloadableProduct -Defines the input schema for updating a company. +Contains details about a single downloadable product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_email` - [`String`](#string) | The email address of the company contact. | -| `company_name` - [`String`](#string) | The name of the company to update. | -| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `date` - [`String`](#string) | The date and time the purchase was made. | +| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "company_email": "abc123", - "company_name": "xyz789", - "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "xyz789", - "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "date": "abc123", + "download_url": "xyz789", + "order_increment_id": "abc123", + "remaining_downloads": "xyz789", + "status": "abc123" } ``` -### CompanyUserCreateInput +### CustomerDownloadableProducts -Defines the input schema for creating a company user. +Contains a list of downloadable products. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The company user's email address | -| `firstname` - [`String!`](#string) | The company user's first name. | -| `job_title` - [`String!`](#string) | The company user's job title or function. | -| `lastname` - [`String!`](#string) | The company user's last name. | -| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`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!`](#string) | The company user's phone number. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | #### Example ```json -{ - "email": "xyz789", - "firstname": "abc123", - "job_title": "xyz789", - "lastname": "abc123", - "role_id": "4", - "status": "ACTIVE", - "target_id": 4, - "telephone": "abc123" -} -``` - - - -### CompanyUserStatusEnum - -Defines the list of company user status values. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ACTIVE` | Only active users. | -| `INACTIVE` | Only inactive users. | - -#### Example - -```json -""ACTIVE"" -``` - - - -### CompanyUserUpdateInput - -Defines the input schema for updating a company user. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String`](#string) | The company user's email address. | -| `firstname` - [`String`](#string) | The company user's first name. | -| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](#string) | The company user's job title or function. | -| `lastname` - [`String`](#string) | The company user's last name. | -| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The company user's phone number. | - -#### Example - -```json -{ - "email": "xyz789", - "firstname": "abc123", - "id": 4, - "job_title": "xyz789", - "lastname": "xyz789", - "role_id": 4, - "status": "ACTIVE", - "telephone": "abc123" -} -``` - - - -### CompanyUsers - -Contains details about company users. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The number of objects returned. | - -#### Example - -```json -{ - "items": [Customer], - "page_info": SearchResultPageInfo, - "total_count": 987 -} +{"items": [CustomerDownloadableProduct]} ``` -### CompanyUsersFilterInput +### CustomerInput -Defines the filter for returning a list of company users. +An input object that assigns or updates customer attributes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | - -#### Example - -```json -{"status": "ACTIVE"} -``` - - - -### ComparableAttribute - -Contains an attribute code that is used for product comparisons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | - -#### Example - -```json -{ - "code": "xyz789", - "label": "xyz789" -} -``` - - - -### ComparableItem - -Defines an object used to iterate through items for product comparisons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | - -#### Example - -```json -{ - "attributes": [ProductAttribute], - "product": ProductInterface, - "uid": 4 -} -``` - - - -### CompareList - -Contains iterable information such as the array of items, the count, and attributes that represent the compare list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](#int) | The number of items in the compare list. | -| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | - -#### Example - -```json -{ - "attributes": [ComparableAttribute], - "item_count": 987, - "items": [ComparableItem], - "uid": "4" -} -``` - - - -### ComplexTextValue - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | - -#### Example - -```json -{"html": "abc123"} -``` - - - -### ConfigurableAttributeOption - -Contains details about a configurable product attribute option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The ID assigned to the attribute. | -| `label` - [`String`](#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | - -#### Example - -```json -{ - "code": "xyz789", - "label": "xyz789", - "uid": 4, - "value_index": 123 -} -``` - - - -### ConfigurableCartItem - -An implementation for configurable product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "xyz789", - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "date_of_birth": "abc123", + "dob": "abc123", + "email": "abc123", + "firstname": "xyz789", + "gender": 123, + "is_subscribed": false, + "lastname": "abc123", + "middlename": "xyz789", + "password": "xyz789", + "prefix": "abc123", + "suffix": "xyz789", + "taxvat": "abc123" } ``` -### ConfigurableOptionAvailableForSelection +### CustomerOrder -Describes configurable options that have been selected and can be selected as a result of the previous selections. +Contains details about each of the customer's orders. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "option_value_uids": [4] -} -``` - - - -### ConfigurableProduct - -Defines basic features of a configurable product and its simple product variants. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | -| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "activity": "xyz789", - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "collar": "xyz789", - "color": 987, - "configurable_options": [ConfigurableProductOptions], - "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 123, - "features_bags": "abc123", - "format": 987, - "gender": "abc123", - "gift_message_available": "abc123", - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "material": "xyz789", - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "new": 123, - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "pattern": "xyz789", - "performance_fabric": 123, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 987, - "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": "abc123", - "sleeve": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "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": "abc123", - "thumbnail": ProductImage, - "tier_price": 123.45, - "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": "xyz789", - "variants": [ConfigurableVariant], - "websites": [Website], - "weight": 987.65 -} -``` - - - -### ConfigurableProductCartItemInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | -| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](#string) | Deprecated. Use `CartItemInput.sku` instead. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "parent_sku": "abc123", - "variant_sku": "abc123" -} -``` - - - -### ConfigurableProductOption - -Contains details about configurable product options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](#string) | The display name of the option. | -| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | -| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "label": "abc123", - "uid": 4, - "values": [ConfigurableProductOptionValue] -} -``` - - - -### ConfigurableProductOptionValue - -Defines a value for a configurable product option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](#id) | The unique ID of the value. | - -#### Example - -```json -{ - "is_available": false, - "is_use_default": true, - "label": "abc123", - "swatch": SwatchDataInterface, - "uid": 4 -} -``` - - - -### ConfigurableProductOptions - -Defines configurable attributes for the specified product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | -| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "attribute_id": "xyz789", - "attribute_id_v2": 123, - "attribute_uid": "4", - "id": 123, - "label": "abc123", - "position": 987, - "product_id": 987, - "uid": 4, - "use_default": false, - "values": [ConfigurableProductOptionsValues] -} -``` - - - -### ConfigurableProductOptionsSelection - -Contains metadata corresponding to the selected configurable options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | -| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | -| `variant` - [`SimpleProduct`](#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 - -```json -{ - "configurable_options": [ConfigurableProductOption], - "media_gallery": [MediaGalleryInterface], - "options_available_for_selection": [ - ConfigurableOptionAvailableForSelection - ], - "variant": SimpleProduct -} -``` - - - -### ConfigurableProductOptionsValues - -Contains the index number assigned to a configurable product option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `default_label` - [`String`](#string) | The label of the product on the default store. | -| `label` - [`String`](#string) | The label of the product. | -| `store_label` - [`String`](#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | - -#### Example - -```json -{ - "default_label": "xyz789", - "label": "abc123", - "store_label": "abc123", - "swatch_data": SwatchDataInterface, - "uid": 4, - "use_default_value": true, - "value_index": 123 -} -``` - - - -### ConfigurableRequisitionListItem - -Contains details about configurable products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | - -#### Example - -```json -{ - "configurable_options": [SelectedConfigurableOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 -} -``` - - - -### ConfigurableVariant - -Contains all the simple product variants of a configurable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | - -#### Example - -```json -{ - "attributes": [ConfigurableAttributeOption], - "product": SimpleProduct -} -``` - - - -### ConfigurableWishlistItem - -A configurable product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "abc123", - "child_sku": "xyz789", - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### CopyItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be copied. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | - -#### Example - -```json -{"requisitionListItemUids": ["4"]} -``` - - - -### CopyItemsFromRequisitionListsOutput - -Output of the request to copy items to the destination requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### CopyProductsBetweenWishlistsOutput - -Contains the source and target wish lists after copying products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | - -#### Example - -```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} -``` - - - -### Country - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](#string) | The name of the country in English. | -| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | -| `id` - [`String`](#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | - -#### Example - -```json -{ - "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "xyz789" -} -``` - - - -### CountryCodeEnum - -The list of country codes. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 | -| `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 &amp; 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 | -| `SZ` | Swaziland | -| `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 | +| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | +| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](#string) | The order number. | +| `order_date` - [`String!`](#string) | The date the order was placed. | +| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | +| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](#string) | The delivery method for the order. | +| `status` - [`String!`](#string) | The current status of the order. | +| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | #### Example ```json -""AF"" +{ + "billing_address": OrderAddress, + "carrier": "xyz789", + "comments": [SalesCommentItem], + "created_at": "xyz789", + "credit_memos": [CreditMemo], + "gift_message": GiftMessage, + "gift_receipt_included": true, + "gift_wrapping": GiftWrapping, + "grand_total": 987.65, + "id": "4", + "increment_id": "xyz789", + "invoices": [Invoice], + "items": [OrderItemInterface], + "items_eligible_for_return": [OrderItemInterface], + "number": "xyz789", + "order_date": "abc123", + "order_number": "xyz789", + "payment_methods": [OrderPaymentMethod], + "printed_card_included": false, + "returns": Returns, + "shipments": [OrderShipment], + "shipping_address": OrderAddress, + "shipping_method": "abc123", + "status": "xyz789", + "total": OrderTotal +} ``` -### CreateCompanyOutput +### CustomerOrderSortInput -Contains the response to the request to create a company. +CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | + +#### Example + +```json +{"sort_direction": "ASC", "sort_field": "NUMBER"} +``` + + + +### CustomerOrderSortableField + +Specifies the field to use for sorting + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NUMBER` | Sorts customer orders by number | +| `CREATED_AT` | Sorts customer orders by created_at field | + +#### Example + +```json +""NUMBER"" +``` + + + +### CustomerOrders + +The collection of orders that match the conditions defined in the filter. #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The new company instance. | +| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer orders. | #### Example ```json -{"company": Company} +{ + "items": [CustomerOrder], + "page_info": SearchResultPageInfo, + "total_count": 987 +} ``` -### CreateCompanyRoleOutput +### CustomerOrdersFilterInput -Contains the response to the request to create a company role. +Identifies the filter to use for filtering orders. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | + +#### Example + +```json +{"number": FilterStringTypeInput} +``` + + + +### CustomerOutput + +Contains details about a newly-created or updated customer. #### Fields | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | +| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | #### Example ```json -{"role": CompanyRole} +{"customer": Customer} ``` -### CreateCompanyTeamOutput +### CustomerPaymentTokens -Contains the response to the request to create a company team. +Contains payment tokens stored in the customer's vault. #### Fields | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | +| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | #### Example ```json -{"team": CompanyTeam} +{"items": [PaymentToken]} ``` -### CreateCompanyUserOutput +### CustomerStoreCredit -Contains the response to the request to create a company user. +Contains store credit information with balance and history. #### Fields | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The new company user instance. | +| `balance_history` - [`CustomerStoreCreditHistory`](#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. | +| `current_balance` - [`Money`](#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example ```json -{"user": Customer} +{ + "balance_history": CustomerStoreCreditHistory, + "current_balance": Money, + "enabled": true +} ``` -### CreateCompareListInput +### CustomerStoreCreditHistory -Contains an array of product IDs to use for creating a compare list. +Lists changes to the amount of store credit available to the customer. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of items returned. | #### Example ```json -{"products": ["4"]} +{ + "items": [CustomerStoreCreditHistoryItem], + "page_info": SearchResultPageInfo, + "total_count": 987 +} ``` -### CreateGiftRegistryInput +### CustomerStoreCreditHistoryItem -Defines a new gift registry. +Contains store credit history information. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | -| `message` - [`String!`](#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| Field Name | Description | +|------------|-------------| +| `action` - [`String`](#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "abc123", - "gift_registry_type_uid": 4, - "message": "xyz789", - "privacy_settings": "PRIVATE", - "registrants": [AddGiftRegistryRegistrantInput], - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" + "action": "xyz789", + "actual_balance": Money, + "balance_change": Money, + "date_time_changed": "abc123" } ``` -### CreateGiftRegistryOutput +### CustomerToken -Contains the results of a request to create a gift registry. +Contains a customer authorization token. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `token` - [`String`](#string) | The customer authorization token. | #### Example ```json -{"gift_registry": GiftRegistry} +{"token": "abc123"} ``` -### CreatePayflowProTokenOutput +### CustomerUpdateInput -Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. +An input object for updating a customer. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | + +#### Example + +```json +{ + "allow_remote_shopping_assistance": true, + "date_of_birth": "xyz789", + "dob": "xyz789", + "firstname": "xyz789", + "gender": 987, + "is_subscribed": true, + "lastname": "abc123", + "middlename": "xyz789", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "abc123" +} +``` + + + +### CustomizableAreaOption + +Contains information about a text area that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "response_message": "abc123", - "result": 987, - "result_code": 123, - "secure_token": "xyz789", - "secure_token_id": "abc123" + "option_id": 987, + "product_sku": "abc123", + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": CustomizableAreaValue } ``` -### CreateProductReviewInput +### CustomizableAreaValue -Defines a new product review. +Defines the price and sku of a product whose page contains a customized text area. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | +| Field Name | Description | +|------------|-------------| +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "nickname": "abc123", - "ratings": [ProductReviewRatingInput], - "sku": "xyz789", - "summary": "xyz789", - "text": "xyz789" + "max_characters": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", + "uid": "4" } ``` -### CreateProductReviewOutput +### CustomizableCheckboxOption -Contains the completed product review. +Contains information about a set of checkbox values that are defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json -{"review": ProductReview} +{ + "option_id": 123, + "required": false, + "sort_order": 987, + "title": "abc123", + "uid": "4", + "value": [CustomizableCheckboxValue] +} ``` -### CreatePurchaseOrderApprovalRuleConditionAmountInput +### CustomizableCheckboxValue -Specifies the amount and currency to evaluate. +Defines the price and sku of a product whose page contains a customized set of checkbox values. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| Field Name | Description | +|------------|-------------| +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json -{"currency": "AFN", "value": 987.65} +{ + "option_type_id": 123, + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 123, + "title": "abc123", + "uid": 4 +} ``` -### CreatePurchaseOrderApprovalRuleConditionInput +### CustomizableDateOption -Defines a set of conditions that apply to a rule. +Contains information about a date picker that is defined as part of a customizable option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | -| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example ```json { - "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN", - "quantity": 987 + "option_id": 123, + "product_sku": "abc123", + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": "4", + "value": CustomizableDateValue } ``` -### CreateRequisitionListInput +### CustomizableDateTypeEnum -An input object that identifies and describes a new requisition list. +Defines the customizable date type. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| Enum Value | Description | +|------------|-------------| +| `DATE` | | +| `DATE_TIME` | | +| `TIME` | | #### Example ```json -{ - "description": "abc123", - "name": "xyz789" -} +""DATE"" ``` -### CreateRequisitionListOutput +### CustomizableDateValue -Output of the request to create a requisition list. +Defines the price and sku of a product whose page contains a customized date picker. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "type": "DATE", + "uid": "4" +} ``` -### CreateWishlistInput +### CustomizableDropDownOption -Defines the name and visibility of a new wish list. +Contains information about a drop down menu that is defined as part of a customizable option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | #### Example ```json -{"name": "xyz789", "visibility": "PUBLIC"} +{ + "option_id": 987, + "required": true, + "sort_order": 123, + "title": "xyz789", + "uid": "4", + "value": [CustomizableDropDownValue] +} ``` -### CreateWishlistOutput +### CustomizableDropDownValue -Contains the wish list. +Defines the price and sku of a product whose page contains a customized drop down menu. #### Fields | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json -{"wishlist": Wishlist} +{ + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 123, + "title": "xyz789", + "uid": 4 +} ``` -### CreditCardDetailsInput +### CustomizableFieldOption -Required fields for Payflow Pro and Payments Pro credit card payments. +Contains information about a text field that is defined as part of a customizable option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](#string) | The credit card type. | +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "cc_exp_month": 123, - "cc_exp_year": 987, - "cc_last_4": 987, - "cc_type": "xyz789" + "option_id": 987, + "product_sku": "abc123", + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": CustomizableFieldValue } ``` -### CreditMemo +### CustomizableFieldValue -Contains credit memo details. +Defines the price and sku of a product whose page contains a customized text field. #### Fields | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | -| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](#string) | The sequential credit memo number. | -| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "comments": [SalesCommentItem], - "id": "4", - "items": [CreditMemoItemInterface], - "number": "xyz789", - "total": CreditMemoTotal + "max_characters": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "uid": 4 } ``` -### CreditMemoItem +### CustomizableFileOption + +Contains information about a file picker that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example ```json { - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "option_id": 987, + "product_sku": "xyz789", + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": CustomizableFileValue } ``` -### CreditMemoItemInterface - -Credit memo item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Possible Types +### CustomizableFileValue -| CreditMemoItemInterface Types | -|----------------| -| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | -| [`CreditMemoItem`](#creditmemoitem) | +Defines the price and sku of a product whose page contains a customized file picker. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `file_extension` - [`String`](#string) | The file extension to accept. | +| `image_size_x` - [`Int`](#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](#int) | The maximum height of an image. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 + "file_extension": "xyz789", + "image_size_x": 987, + "image_size_y": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "uid": "4" } ``` -### CreditMemoTotal +### CustomizableMultipleOption -Contains credit memo price details. +Contains information about a multiselect that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example ```json { - "adjustment": Money, - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money + "option_id": 123, + "required": false, + "sort_order": 987, + "title": "abc123", + "uid": 4, + "value": [CustomizableMultipleValue] } ``` -### Currency +### CustomizableMultipleValue + +Defines the price and sku of a product whose page contains a customized multiselect. #### Fields | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | -| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { - "available_currency_codes": ["abc123"], - "base_currency_code": "abc123", - "base_currency_symbol": "abc123", - "default_display_currecy_code": "abc123", - "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "xyz789", - "exchange_rates": [ExchangeRate] + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": 4 } ``` -### CurrencyEnum - -The list of available currency codes. - -#### Values +### CustomizableOptionInput -| Enum Value | Description | -|------------|-------------| -| `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` | | +Defines a customizable option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`Int`](#int) | The customizable option ID of the product. | +| `value_string` - [`String!`](#string) | The string value of the option. | #### Example ```json -""AFN"" +{"id": 123, "value_string": "xyz789"} ``` -### CustomAttributeMetadata +### CustomizableOptionInterface -Defines an array of custom attributes. +Contains basic information about a customizable option. It can be implemented by several types of configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | + +#### Possible Types + +| CustomizableOptionInterface Types | +|----------------| +| [`CustomizableAreaOption`](#customizableareaoption) | +| [`CustomizableDateOption`](#customizabledateoption) | +| [`CustomizableDropDownOption`](#customizabledropdownoption) | +| [`CustomizableMultipleOption`](#customizablemultipleoption) | +| [`CustomizableFieldOption`](#customizablefieldoption) | +| [`CustomizableFileOption`](#customizablefileoption) | +| [`CustomizableRadioOption`](#customizableradiooption) | +| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | #### Example ```json -{"items": [Attribute]} +{ + "option_id": 123, + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": 4 +} ``` -### Customer +### CustomizableProductInterface -Defines the customer name, addresses, and other details. +Contains information about customizable product options. #### Fields | Field Name | Description | |------------|-------------| -| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](#string) | The customer's email address. Required. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | -| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`Int`](#int) | The ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | -| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | -| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | -| `telephone` - [`String`](#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](#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. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | + +#### Possible Types + +| CustomizableProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`ConfigurableProduct`](#configurableproduct) | + +#### Example + +```json +{"options": [CustomizableOptionInterface]} +``` + + + +### CustomizableRadioOption + +Contains information about a set of radio buttons that are defined as part of a customizable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example ```json { - "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": true, - "compare_list": CompareList, - "created_at": "abc123", - "date_of_birth": "abc123", - "default_billing": "abc123", - "default_shipping": "abc123", - "dob": "abc123", - "email": "abc123", - "firstname": "xyz789", - "gender": 123, - "gift_registries": [GiftRegistry], - "gift_registry": GiftRegistry, - "group_id": 123, - "id": 987, - "is_subscribed": false, - "job_title": "abc123", - "lastname": "abc123", - "middlename": "abc123", - "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, - "status": "ACTIVE", - "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "xyz789", - "taxvat": "xyz789", - "team": CompanyTeam, - "telephone": "xyz789", - "wishlist": Wishlist, - "wishlist_v2": Wishlist, - "wishlists": [Wishlist] + "option_id": 123, + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": [CustomizableRadioValue] +} +``` + + + +### CustomizableRadioValue + +Defines the price and sku of a product whose page contains a customized set of radio buttons. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | + +#### Example + +```json +{ + "option_type_id": 123, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 123, + "title": "xyz789", + "uid": 4 +} +``` + + + +### DeleteCompanyRoleOutput + +Contains the response to the request to delete the company role. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | + +#### Example + +```json +{"success": false} +``` + + + +### DeleteCompanyTeamOutput + +Contains the status of the request to delete a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | + +#### Example + +```json +{"success": false} +``` + + + +### DeleteCompanyUserOutput + +Contains the response to the request to delete the company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | + +#### Example + +```json +{"success": true} +``` + + + +### DeleteCompareListOutput + +Contains the results of the request to delete a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | + +#### Example + +```json +{"result": true} +``` + + + +### DeleteNegotiableQuoteError + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | + +#### Example + +```json +NegotiableQuoteInvalidStateError +``` + + + +### DeleteNegotiableQuoteOperationFailure + +Contains details about a failed delete operation on a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": "4" } ``` -### CustomerAddress +### DeleteNegotiableQuoteOperationResult + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | + +#### Example + +```json +NegotiableQuoteUidOperationSuccess +``` + + + +### DeleteNegotiableQuotesInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | + +#### Example + +```json +{"quote_uids": ["4"]} +``` + + + +### DeleteNegotiableQuotesOutput -Contains detailed information about a customer's billing or shipping address. +Contains a list of undeleted negotiable quotes the company user can view. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | -| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Custom attributes should not be put into a container.)* | -| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | -| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. | -| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example ```json { - "city": "abc123", - "company": "abc123", - "country_code": "AF", - "country_id": "abc123", - "custom_attributes": [CustomerAddressAttribute], - "customer_id": 123, - "default_billing": false, - "default_shipping": true, - "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "abc123", - "id": 123, - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "xyz789" + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" } ``` -### CustomerAddressAttribute +### DeletePaymentTokenOutput -Specifies the attribute code and value of a customer address attribute. +Indicates whether the request succeeded and returns the remaining customer payment tokens. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](#string) | The valuue assigned to the customer address attribute. | +| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | #### Example ```json { - "attribute_code": "abc123", - "value": "xyz789" + "customerPaymentTokens": CustomerPaymentTokens, + "result": false } ``` -### CustomerAddressAttributeInput +### DeletePurchaseOrderApprovalRuleError -Specifies the attribute code and value of a customer attribute. +Contains details about an error that occurred when deleting an approval rule . -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The text of the error message. | +| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{ - "attribute_code": "abc123", - "value": "xyz789" -} +{"message": "xyz789", "type": "UNDEFINED"} ``` -### CustomerAddressInput - -Contains details about a billing or shipping address. +### DeletePurchaseOrderApprovalRuleErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | Deprecated: use `country_code` instead. | -| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | Deprecated: Custom attributes should not be put into container. | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | +| Enum Value | Description | +|------------|-------------| +| `UNDEFINED` | | +| `NOT_FOUND` | | #### Example ```json -{ - "city": "xyz789", - "company": "abc123", - "country_code": "AF", - "country_id": "AF", - "custom_attributes": [CustomerAddressAttributeInput], - "default_billing": true, - "default_shipping": false, - "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" -} +""UNDEFINED"" ``` -### CustomerAddressRegion +### DeletePurchaseOrderApprovalRuleInput -Defines the customer's state or province. +Specifies the IDs of the approval rules to delete. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| Input Field | Description | +|-------------|-------------| +| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | #### Example ```json -{ - "region": "abc123", - "region_code": "abc123", - "region_id": 123 -} +{"approval_rule_uids": [4]} ``` -### CustomerAddressRegionInput +### DeletePurchaseOrderApprovalRuleOutput -Defines the customer's state or province. +Contains any errors encountered while attempting to delete approval rules. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| Field Name | Description | +|------------|-------------| +| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | #### Example ```json -{ - "region": "abc123", - "region_code": "abc123", - "region_id": 987 -} +{"errors": [DeletePurchaseOrderApprovalRuleError]} ``` -### CustomerCreateInput +### DeleteRequisitionListItemsOutput -An input object for creating a customer. +Output of the request to remove items from the requisition list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String!`](#string) | The customer's email address. | -| `firstname` - [`String!`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | #### Example ```json -{ - "allow_remote_shopping_assistance": false, - "date_of_birth": "xyz789", - "dob": "xyz789", - "email": "xyz789", - "firstname": "abc123", - "gender": 987, - "is_subscribed": true, - "lastname": "abc123", - "middlename": "xyz789", - "password": "abc123", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "abc123" -} +{"requisition_list": RequisitionList} ``` -### CustomerDownloadableProduct +### DeleteRequisitionListOutput -Contains details about a single downloadable product. +Indicates whether the request to delete the requisition list was successful. #### Fields | Field Name | Description | |------------|-------------| -| `date` - [`String`](#string) | The date and time the purchase was made. | -| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | +| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{ - "date": "abc123", - "download_url": "abc123", - "order_increment_id": "abc123", - "remaining_downloads": "xyz789", - "status": "xyz789" -} +{"requisition_lists": RequisitionLists, "status": true} ``` -### CustomerDownloadableProducts +### DeleteWishlistOutput -Contains a list of downloadable products. +Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"items": [CustomerDownloadableProduct]} +{"status": true, "wishlists": [Wishlist]} ``` -### CustomerInput +### Discount -An input object that assigns or updates customer attributes. +Defines an individual discount. A discount can be applied to the cart as a whole or to an item. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | +| `label` - [`String!`](#string) | A description of the discount. | #### Example ```json { - "date_of_birth": "xyz789", - "dob": "xyz789", - "email": "abc123", - "firstname": "abc123", - "gender": 987, - "is_subscribed": true, - "lastname": "xyz789", - "middlename": "abc123", - "password": "xyz789", - "prefix": "xyz789", - "suffix": "xyz789", - "taxvat": "abc123" + "amount": Money, + "label": "xyz789" } ``` -### CustomerOrder +### DownloadableCartItem -Contains details about each of the customer's orders. +An implementation for downloadable product cart items. #### Fields | Field Name | Description | |------------|-------------| -| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | -| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | -| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](#string) | The order number. | -| `order_date` - [`String!`](#string) | The date the order was placed. | -| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | -| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](#string) | The delivery method for the order. | -| `status` - [`String!`](#string) | The current status of the order. | -| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "billing_address": OrderAddress, - "carrier": "abc123", - "comments": [SalesCommentItem], - "created_at": "abc123", - "credit_memos": [CreditMemo], - "gift_message": GiftMessage, - "gift_receipt_included": true, - "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": 4, - "increment_id": "xyz789", - "invoices": [Invoice], - "items": [OrderItemInterface], - "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", - "order_date": "abc123", - "order_number": "abc123", - "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, - "returns": Returns, - "shipments": [OrderShipment], - "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", - "total": OrderTotal + "customizable_options": [SelectedCustomizableOption], + "errors": [CartItemError], + "id": "abc123", + "links": [DownloadableProductLinks], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples], + "uid": 4 } ``` -### CustomerOrderSortInput +### DownloadableCreditMemoItem -CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. +Defines downloadable product options for `CreditMemoItemInterface`. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | -| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json -{"sort_direction": "ASC", "sort_field": "NUMBER"} +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 +} ``` -### CustomerOrderSortableField - -Specifies the field to use for sorting +### DownloadableFileTypeEnum #### Values | Enum Value | Description | |------------|-------------| -| `NUMBER` | Sorts customer orders by number | -| `CREATED_AT` | Sorts customer orders by created_at field | +| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | #### Example ```json -""NUMBER"" +""FILE"" ``` -### CustomerOrders +### DownloadableInvoiceItem -The collection of orders that match the conditions defined in the filter. +Defines downloadable product options for `InvoiceItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer orders. | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example ```json { - "items": [CustomerOrder], - "page_info": SearchResultPageInfo, - "total_count": 123 + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 } ``` -### CustomerOrdersFilterInput +### DownloadableItemsLinks -Identifies the filter to use for filtering orders. +Defines characteristics of the links for downloadable product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | +| Field Name | Description | +|------------|-------------| +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json -{"number": FilterStringTypeInput} +{ + "sort_order": 987, + "title": "abc123", + "uid": "4" +} ``` -### CustomerOutput +### DownloadableOrderItem -Contains details about a newly-created or updated customer. +Defines downloadable product options for `OrderItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json -{"customer": Customer} +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "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": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} ``` -### CustomerPaymentTokens +### DownloadableProduct -Contains payment tokens stored in the customer's vault. +Defines a product that the shopper downloads. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | +| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example ```json -{"items": [PaymentToken]} +{ + "activity": "xyz789", + "attribute_set_id": 987, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "abc123", + "collar": "abc123", + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "downloadable_product_links": [ + DownloadableProductLinks + ], + "downloadable_product_samples": [ + DownloadableProductSamples + ], + "eco_collection": 987, + "erin_recommends": 987, + "features_bags": "xyz789", + "format": 987, + "gender": "abc123", + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "links_purchased_separately": 123, + "links_title": "xyz789", + "manufacturer": 123, + "material": "xyz789", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "pattern": "xyz789", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 987, + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "sale": 123, + "short_description": ComplexTextValue, + "size": 123, + "sku": "abc123", + "sleeve": "xyz789", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": false, + "stock_status": "IN_STOCK", + "strap_bags": "xyz789", + "style_bags": "abc123", + "style_bottom": "xyz789", + "style_general": "abc123", + "swatch_image": "xyz789", + "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": "xyz789", + "websites": [Website] +} ``` -### CustomerStoreCredit +### DownloadableProductCartItemInput -Contains store credit information with balance and history. +Defines a single downloadable product. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `balance_history` - [`CustomerStoreCreditHistory`](#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. | -| `current_balance` - [`Money`](#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | +| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | #### Example ```json { - "balance_history": CustomerStoreCreditHistory, - "current_balance": Money, - "enabled": true + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "downloadable_product_links": [ + DownloadableProductLinksInput + ] } ``` -### CustomerStoreCreditHistory +### DownloadableProductLinks -Lists changes to the amount of store credit available to the customer. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of items returned. | +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](#float) | The price of the downloadable product. | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { - "items": [CustomerStoreCreditHistoryItem], - "page_info": SearchResultPageInfo, - "total_count": 987 + "id": 123, + "is_shareable": true, + "link_type": "FILE", + "number_of_downloads": 987, + "price": 987.65, + "sample_file": "abc123", + "sample_type": "FILE", + "sample_url": "abc123", + "sort_order": 123, + "title": "xyz789", + "uid": "4" } ``` -### CustomerStoreCreditHistoryItem - -Contains store credit history information. +### DownloadableProductLinksInput -#### Fields +Contains the link ID for the downloadable product. -| Field Name | Description | -|------------|-------------| -| `action` - [`String`](#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | #### Example ```json -{ - "action": "abc123", - "actual_balance": Money, - "balance_change": Money, - "date_time_changed": "xyz789" -} +{"link_id": 987} ``` -### CustomerToken +### DownloadableProductSamples -Contains a customer authorization token. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the sample. | #### Example ```json -{"token": "xyz789"} +{ + "id": 987, + "sample_file": "xyz789", + "sample_type": "FILE", + "sample_url": "abc123", + "sort_order": 987, + "title": "abc123" +} ``` -### CustomerUpdateInput +### DownloadableRequisitionListItem -An input object for updating a customer. +Contains details about downloadable products added to a requisition list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json { - "allow_remote_shopping_assistance": false, - "date_of_birth": "abc123", - "dob": "xyz789", - "firstname": "abc123", - "gender": 987, - "is_subscribed": true, - "lastname": "xyz789", - "middlename": "abc123", - "prefix": "xyz789", - "suffix": "abc123", - "taxvat": "xyz789" + "customizable_options": [SelectedCustomizableOption], + "links": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples], + "uid": 4 } ``` -### CustomizableAreaOption +### DownloadableWishlistItem -Contains information about a text area that is defined as part of a customizable option. +A downloadable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "option_id": 987, - "product_sku": "xyz789", - "required": false, - "sort_order": 987, - "title": "xyz789", - "uid": 4, - "value": CustomizableAreaValue + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "links_v2": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples] } ``` -### CustomizableAreaValue +### DynamicBlock -Defines the price and sku of a product whose page contains a customized text area. +Contains a single dynamic block. #### Fields | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | +| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | +| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json { - "max_characters": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", + "content": ComplexTextValue, "uid": "4" } ``` -### CustomizableCheckboxOption +### DynamicBlockLocationEnum -Contains information about a set of checkbox values that are defined as part of a customizable option. +Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | +| `CONTENT` | | +| `HEADER` | | +| `FOOTER` | | +| `LEFT` | | +| `RIGHT` | | #### Example ```json -{ - "option_id": 987, - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": [CustomizableCheckboxValue] -} +""CONTENT"" ``` -### CustomizableCheckboxValue +### DynamicBlockTypeEnum -Defines the price and sku of a product whose page contains a customized set of checkbox values. +Indicates the selected Dynamic Blocks Rotator inline widget. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | +| `SPECIFIED` | | +| `CART_PRICE_RULE_RELATED` | | +| `CATALOG_PRICE_RULE_RELATED` | | #### Example ```json -{ - "option_type_id": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} +""SPECIFIED"" ``` -### CustomizableDateOption +### DynamicBlocks -Contains information about a date picker that is defined as part of a customizable option. +Contains an array of dynamic blocks. #### Fields | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | +| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | #### Example ```json { - "option_id": 123, - "product_sku": "xyz789", - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": 4, - "value": CustomizableDateValue + "items": [DynamicBlock], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### CustomizableDateTypeEnum +### DynamicBlocksFilterInput -Defines the customizable date type. +Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `DATE` | | -| `DATE_TIME` | | -| `TIME` | | +| Input Field | Description | +|-------------|-------------| +| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | +| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | #### Example ```json -""DATE"" +{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"} ``` -### CustomizableDateValue +### EnteredCustomAttributeInput -Defines the price and sku of a product whose page contains a customized date picker. +Contains details about a custom text attribute that the buyer entered. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](#string) | The text or other entered value. | #### Example ```json { - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "type": "DATE", - "uid": 4 + "attribute_code": "abc123", + "value": "xyz789" } ``` -### CustomizableDropDownOption +### EnteredOptionInput -Contains information about a drop down menu that is defined as part of a customizable option. +Defines a customer-entered option. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | +| Input Field | Description | +|-------------|-------------| +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](#string) | Text the customer entered. | #### Example ```json { - "option_id": 123, - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": 4, - "value": [CustomizableDropDownValue] + "uid": "4", + "value": "xyz789" } ``` -### CustomizableDropDownValue +### EntityUrl -Defines the price and sku of a product whose page contains a customized drop down menu. +Contains the `uid`, `relative_url`, and `type` attributes. #### Fields | Field Name | Description | |------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | +| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | +| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "option_type_id": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "xyz789", - "uid": 4 + "canonical_url": "abc123", + "entity_uid": "4", + "id": 123, + "redirectCode": 123, + "relative_url": "abc123", + "type": "CMS_PAGE" } ``` -### CustomizableFieldOption - -Contains information about a text field that is defined as part of a customizable option. +### ErrorInterface #### Fields | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | +| `message` - [`String!`](#string) | The returned error message. | + +#### Possible Types + +| ErrorInterface Types | +|----------------| +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | #### Example ```json -{ - "option_id": 987, - "product_sku": "xyz789", - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": CustomizableFieldValue -} +{"message": "xyz789"} ``` -### CustomizableFieldValue +### ExchangeRate -Defines the price and sku of a product whose page contains a customized text field. +Lists the exchange rate. #### Fields | Field Name | Description | |------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | +| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | #### Example ```json -{ - "max_characters": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 -} +{"currency_to": "abc123", "rate": 987.65} ``` + +### createEmptyCartInput + +Assigns a specific `cart_id` to the empty cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String`](#string) | The ID to assign to the cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md new file mode 100644 index 000000000..a258b2e2a --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md @@ -0,0 +1,2134 @@ +## Types + +### FilterEqualTypeInput + +Defines a filter that matches the input exactly. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#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]`](#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 + +```json +{ + "eq": "abc123", + "in": ["xyz789"] +} +``` + + + +### FilterMatchTypeInput + +Defines a filter that performs a fuzzy search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `match` - [`String`](#string) | Use this attribute to exactly match the specified string. For example, to filter on a specific SKU, specify a value such as `24-MB01`. | + +#### Example + +```json +{"match": "xyz789"} +``` + + + +### FilterRangeTypeInput + +Defines a filter that matches a range of values, such as prices or dates. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | + +#### Example + +```json +{ + "from": "xyz789", + "to": "xyz789" +} +``` + + + +### FilterStringTypeInput + +Defines a filter for an input string. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | + +#### Example + +```json +{ + "eq": "abc123", + "in": ["abc123"], + "match": "xyz789" +} +``` + + + +### FilterTypeInput + +Defines the comparison operators that can be used in a filter. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Equals. | +| `finset` - [`[String]`](#string) | | +| `from` - [`String`](#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](#string) | Greater than. | +| `gteq` - [`String`](#string) | Greater than or equal to. | +| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](#string) | Less than. | +| `lteq` - [`String`](#string) | Less than or equal to. | +| `moreq` - [`String`](#string) | More than or equal to. | +| `neq` - [`String`](#string) | Not equal to. | +| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](#string) | Not null. | +| `null` - [`String`](#string) | Is null. | +| `to` - [`String`](#string) | To. Must be used with the `from` field. | + +#### Example + +```json +{ + "eq": "xyz789", + "finset": ["xyz789"], + "from": "xyz789", + "gt": "xyz789", + "gteq": "abc123", + "in": ["abc123"], + "like": "xyz789", + "lt": "xyz789", + "lteq": "abc123", + "moreq": "abc123", + "neq": "abc123", + "nin": ["xyz789"], + "notnull": "abc123", + "null": "abc123", + "to": "xyz789" +} +``` + + + +### FixedProductTax + +A single FPT that can be applied to a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | + +#### Example + +```json +{ + "amount": Money, + "label": "abc123" +} +``` + + + +### FixedProductTaxDisplaySettings + +Lists display settings for the Fixed Product Tax. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""INCLUDE_FPT_WITHOUT_DETAILS"" +``` + + + +### Float + +The `Float` scalar type represents signed double-precision fractional +values as specified by +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). + +#### Example + +```json +987.65 +``` + + + +### GenerateCustomerTokenAsAdminInput + +Identifies which customer requires remote shopping assistance. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | + +#### Example + +```json +{"customer_email": "abc123"} +``` + + + +### GenerateCustomerTokenAsAdminOutput + +Contains the generated customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer_token` - [`String!`](#string) | The generated customer token. | + +#### Example + +```json +{"customer_token": "abc123"} +``` + + + +### GiftCardAccount + +Contains details about the gift card account. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`Money`](#money) | The balance remaining on the gift card. | +| `code` - [`String`](#string) | The gift card account code. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "balance": Money, + "code": "abc123", + "expiration_date": "abc123" +} +``` + + + +### GiftCardAccountInput + +Contains the gift card code. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_card_code` - [`String!`](#string) | The applied gift card code. | + +#### Example + +```json +{"gift_card_code": "abc123"} +``` + + + +### GiftCardAmounts + +Contains the value of a gift card, the website that generated the card, and related information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_id` - [`Int`](#int) | An internal attribute ID. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | +| `value` - [`Float`](#float) | The value of the gift card. | +| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | +| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | +| `website_value` - [`Float`](#float) | The value of the gift card. | + +#### Example + +```json +{ + "attribute_id": 987, + "uid": 4, + "value": 987.65, + "value_id": 123, + "website_id": 987, + "website_value": 987.65 +} +``` + + + +### GiftCardCartItem + +Contains details about a gift card that has been added to a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender. | +| `sender_name` - [`String!`](#string) | The name of the sender. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "amount": Money, + "customizable_options": [SelectedCustomizableOption], + "errors": [CartItemError], + "id": "abc123", + "message": "xyz789", + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "recipient_email": "abc123", + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "xyz789", + "uid": 4 +} +``` + + + +### GiftCardCreditMemoItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 123.45 +} +``` + + + +### GiftCardInvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 123.45 +} +``` + + + +### GiftCardItem + +Contains details about a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | + +#### Example + +```json +{ + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", + "sender_email": "abc123", + "sender_name": "abc123" +} +``` + + + +### GiftCardOptions + +Contains details about the sender, recipient, and amount of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](#string) | A message to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | + +#### Example + +```json +{ + "amount": Money, + "custom_giftcard_amount": Money, + "message": "abc123", + "recipient_email": "xyz789", + "recipient_name": "xyz789", + "sender_email": "xyz789", + "sender_name": "xyz789" +} +``` + + + +### GiftCardOrderItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "discounts": [Discount], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_card": GiftCardItem, + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "xyz789", + "product_url_key": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "abc123" +} +``` + + + +### GiftCardProduct + +Defines properties of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | +| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | +| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "xyz789", + "allow_message": false, + "allow_open_amount": false, + "attribute_set_id": 123, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "xyz789", + "climate": "abc123", + "collar": "abc123", + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "eco_collection": 123, + "erin_recommends": 123, + "features_bags": "xyz789", + "format": 123, + "gender": "abc123", + "gift_card_options": [CustomizableOptionInterface], + "gift_message_available": "xyz789", + "giftcard_amounts": [GiftCardAmounts], + "giftcard_type": "VIRTUAL", + "id": 123, + "image": ProductImage, + "is_redeemable": true, + "is_returnable": "abc123", + "lifetime": 123, + "manufacturer": 123, + "material": "abc123", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "message_max_length": 123, + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "abc123", + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "open_amount_max": 987.65, + "open_amount_min": 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, + "rating_summary": 123.45, + "redirect_code": 987, + "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": "xyz789", + "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": "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": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 123.45 +} +``` + + + +### GiftCardRequisitionListItem + +Contains details about gift cards added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "gift_card_options": GiftCardOptions, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### GiftCardShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "gift_card": GiftCardItem, + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 123.45 +} +``` + + + +### GiftCardTypeEnum + +Specifies the gift card type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `VIRTUAL` | | +| `PHYSICAL` | | +| `COMBINED` | | + +#### Example + +```json +""VIRTUAL"" +``` + + + +### GiftCardWishlistItem + +A single gift card added to a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "gift_card_options": GiftCardOptions, + "id": 4, + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### GiftMessage + +Contains the text of a gift message, its sender, and recipient + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `from` - [`String!`](#string) | Sender name | +| `message` - [`String!`](#string) | Gift message text | +| `to` - [`String!`](#string) | Recipient name | + +#### Example + +```json +{ + "from": "abc123", + "message": "xyz789", + "to": "abc123" +} +``` + + + +### GiftMessageInput + +Defines a gift message. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String!`](#string) | The name of the sender. | +| `message` - [`String!`](#string) | The text of the gift message. | +| `to` - [`String!`](#string) | The name of the recepient. | + +#### Example + +```json +{ + "from": "xyz789", + "message": "xyz789", + "to": "abc123" +} +``` + + + +### GiftOptionsPrices + +Contains prices for gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | +| `printed_card` - [`Money`](#money) | Price for the printed card. | + +#### Example + +```json +{ + "gift_wrapping_for_items": Money, + "gift_wrapping_for_order": Money, + "printed_card": Money +} +``` + + + +### GiftRegistry + +Contains details about a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | +| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | +| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | +| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | +| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | + +#### Example + +```json +{ + "created_at": "xyz789", + "dynamic_attributes": [GiftRegistryDynamicAttribute], + "event_name": "xyz789", + "items": [GiftRegistryItemInterface], + "message": "abc123", + "owner_name": "xyz789", + "privacy_settings": "PRIVATE", + "registrants": [GiftRegistryRegistrant], + "shipping_address": CustomerAddress, + "status": "ACTIVE", + "type": GiftRegistryType, + "uid": 4 +} +``` + + + +### GiftRegistryDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": "4", + "group": "EVENT_INFORMATION", + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### GiftRegistryDynamicAttributeGroup + +Defines the group type of a gift registry dynamic attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `EVENT_INFORMATION` | | +| `PRIVACY_SETTINGS` | | +| `REGISTRANT` | | +| `GENERAL_INFORMATION` | | +| `DETAILED_INFORMATION` | | +| `SHIPPING_ADDRESS` | | + +#### Example + +```json +""EVENT_INFORMATION"" +``` + + + +### GiftRegistryDynamicAttributeInput + +Defines a dynamic attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | +| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | + +#### Example + +```json +{ + "code": "4", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Possible Types + +| GiftRegistryDynamicAttributeInterface Types | +|----------------| +| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | +| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | + +#### Example + +```json +{ + "code": "4", + "label": "xyz789", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeMetadata + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Example + +```json +{ + "attribute_group": "xyz789", + "code": 4, + "input_type": "abc123", + "is_required": true, + "label": "xyz789", + "sort_order": 987 +} +``` + + + +### GiftRegistryDynamicAttributeMetadataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Possible Types + +| GiftRegistryDynamicAttributeMetadataInterface Types | +|----------------| +| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | + +#### Example + +```json +{ + "attribute_group": "xyz789", + "code": "4", + "input_type": "abc123", + "is_required": false, + "label": "xyz789", + "sort_order": 123 +} +``` + + + +### GiftRegistryItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "abc123", + "product": ProductInterface, + "quantity": 123.45, + "quantity_fulfilled": 987.65, + "uid": "4" +} +``` + + + +### GiftRegistryItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Possible Types + +| GiftRegistryItemInterface Types | +|----------------| +| [`GiftRegistryItem`](#giftregistryitem) | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "abc123", + "product": ProductInterface, + "quantity": 987.65, + "quantity_fulfilled": 987.65, + "uid": "4" +} +``` + + + +### GiftRegistryItemUserErrorInterface + +Contains the status and any errors that encountered with the customer's gift register item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | + +#### Possible Types + +| GiftRegistryItemUserErrorInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{ + "status": false, + "user_errors": [GiftRegistryItemsUserError] +} +``` + + + +### GiftRegistryItemsUserError + +Contains details about an error that occurred when processing a gift registry item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | +| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | +| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | +| `message` - [`String!`](#string) | A localized error message. | +| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | + +#### Example + +```json +{ + "code": "OUT_OF_STOCK", + "gift_registry_item_uid": "4", + "gift_registry_uid": 4, + "message": "xyz789", + "product_uid": 4 +} +``` + + + +### GiftRegistryItemsUserErrorType + +Defines the error type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""OUT_OF_STOCK"" +``` + + + +### GiftRegistryOutputInterface + +Contains the customer's gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | + +#### Possible Types + +| GiftRegistryOutputInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### GiftRegistryPrivacySettings + +Defines the privacy setting of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRIVATE` | | +| `PUBLIC` | | + +#### Example + +```json +""PRIVATE"" +``` + + + +### GiftRegistryRegistrant + +Contains details about a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | +| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryRegistrantDynamicAttribute + ], + "email": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "uid": "4" +} +``` + + + +### GiftRegistryRegistrantDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": "4", + "label": "abc123", + "value": "abc123" +} +``` + + + +### GiftRegistrySearchResult + +Contains the results of a gift registry search. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `event_date` - [`String`](#string) | The date of the event. | +| `event_title` - [`String!`](#string) | The title given to the event. | +| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | +| `location` - [`String`](#string) | The location of the event. | +| `name` - [`String!`](#string) | The name of the gift registry owner. | +| `type` - [`String`](#string) | The type of event being held. | + +#### Example + +```json +{ + "event_date": "abc123", + "event_title": "xyz789", + "gift_registry_uid": "4", + "location": "xyz789", + "name": "xyz789", + "type": "abc123" +} +``` + + + +### GiftRegistryShippingAddressInput + +Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | + +#### Example + +```json +{"address_data": CustomerAddressInput, "address_id": 4} +``` + + + +### GiftRegistryStatus + +Defines the status of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | + +#### Example + +```json +""ACTIVE"" +``` + + + +### GiftRegistryType + +Contains details about a gift registry type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | + +#### Example + +```json +{ + "dynamic_attributes_metadata": [ + GiftRegistryDynamicAttributeMetadataInterface + ], + "label": "xyz789", + "uid": 4 +} +``` + + + +### GiftWrapping + +Contains details about the selected or available gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | +| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | +| `price` - [`Money!`](#money) | The gift wrapping price. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | + +#### Example + +```json +{ + "design": "abc123", + "id": 4, + "image": GiftWrappingImage, + "price": Money, + "uid": "4" +} +``` + + + +### GiftWrappingImage + +Points to an image associated with a gift wrapping option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The gift wrapping preview image label. | +| `url` - [`String!`](#string) | The gift wrapping preview image URL. | + +#### Example + +```json +{ + "label": "xyz789", + "url": "xyz789" +} +``` + + + +### GroupedProduct + +Defines a grouped product, which consists of simple standalone products that are presented as a group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "xyz789", + "attribute_set_id": 123, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "abc123", + "collar": "abc123", + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "eco_collection": 987, + "erin_recommends": 123, + "features_bags": "xyz789", + "format": 123, + "gender": "abc123", + "gift_message_available": "abc123", + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "items": [GroupedProductItem], + "manufacturer": 123, + "material": "abc123", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options_container": "abc123", + "pattern": "xyz789", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 987, + "rating_summary": 987.65, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "sale": 123, + "short_description": ComplexTextValue, + "size": 987, + "sku": "xyz789", + "sleeve": "xyz789", + "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": 123.45, + "tier_prices": [ProductTierPrices], + "type": "CMS_PAGE", + "type_id": "abc123", + "uid": "4", + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### GroupedProductItem + +Contains information about an individual grouped product item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | +| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | +| `qty` - [`Float`](#float) | The quantity of this grouped product item. | + +#### Example + +```json +{ + "position": 987, + "product": ProductInterface, + "qty": 987.65 +} +``` + + + +### GroupedProductWishlistItem + +A grouped product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### HostedProInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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 + +```json +{ + "cancel_url": "xyz789", + "return_url": "xyz789" +} +``` + + + +### HostedProUrl + +Contains the secure URL used for the Payments Pro Hosted Solution payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | + +#### Example + +```json +{"secure_form_url": "abc123"} +``` + + + +### HostedProUrlInput + +Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### HttpQueryParameter + +Contains target path parameters. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | A parameter name. | +| `value` - [`String`](#string) | A parameter value. | + +#### Example + +```json +{ + "name": "xyz789", + "value": "xyz789" +} +``` + + + +### ID + +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 + +```json +4 +``` + + + +### ImageSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{ + "thumbnail": "abc123", + "value": "xyz789" +} +``` + + + +### Int + +The `Int` scalar type represents non-fractional signed whole numeric +values. Int can represent values between -(2^31) and 2^31 - 1. + +#### Example + +```json +123 +``` + + + +### InternalError + +Contains an error message when an internal error occurred. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | + +#### Example + +```json +{"message": "abc123"} +``` + + + +### Invoice + +Contains invoice details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | +| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | +| `number` - [`String!`](#string) | Sequential invoice number. | +| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "id": "4", + "items": [InvoiceItemInterface], + "number": "xyz789", + "total": InvoiceTotal +} +``` + + + +### InvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### InvoiceItemInterface + +Contains detailes about invoiced items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Possible Types + +| InvoiceItemInterface Types | +|----------------| +| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | +| [`InvoiceItem`](#invoiceitem) | + +#### Example + +```json +{ + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 123.45 +} +``` + + + +### InvoiceTotal + +Contains price details from an invoice. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | + +#### Example + +```json +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money +} +``` + + + +### IsCompanyAdminEmailAvailableOutput + +Contains the response of a company admin email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsCompanyEmailAvailableOutput + +Contains the response of a company email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsCompanyRoleNameAvailableOutput + +Contains the response of a role name validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | + +#### Example + +```json +{"is_role_name_available": true} +``` + + + +### IsCompanyUserEmailAvailableOutput + +Contains the response of a company user email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsEmailAvailableOutput + +Contains the result of the `isEmailAvailable` query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### ItemSelectedBundleOption + +A list of options of the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String!`](#string) | The label of the option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | +| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | + +#### Example + +```json +{ + "id": "4", + "label": "xyz789", + "uid": "4", + "values": [ItemSelectedBundleOptionValue] +} +``` + + + +### ItemSelectedBundleOptionValue + +A list of values for the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | +| `price` - [`Money!`](#money) | The price of the child bundle product. | +| `product_name` - [`String!`](#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | +| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | + +#### Example + +```json +{ + "id": 4, + "price": Money, + "product_name": "abc123", + "product_sku": "xyz789", + "quantity": 123.45, + "uid": "4" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-k-p.md new file mode 100644 index 000000000..9f33cf2f5 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-k-p.md @@ -0,0 +1,3772 @@ +## Types + +### KeyValue + +Contains a key-value pair. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | The name part of the key/value pair. | +| `value` - [`String`](#string) | The value part of the key/value pair. | + +#### Example + +```json +{ + "name": "abc123", + "value": "abc123" +} +``` + + + +### LayerFilter + +Contains information for rendering layered navigation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | +| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | + +#### Example + +```json +{ + "filter_items": [LayerFilterItemInterface], + "filter_items_count": 123, + "name": "abc123", + "request_var": "abc123" +} +``` + + + +### LayerFilterItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Example + +```json +{ + "items_count": 987, + "label": "xyz789", + "value_string": "abc123" +} +``` + + + +### LayerFilterItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Possible Types + +| LayerFilterItemInterface Types | +|----------------| +| [`LayerFilterItem`](#layerfilteritem) | +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | + +#### Example + +```json +{ + "items_count": 123, + "label": "abc123", + "value_string": "abc123" +} +``` + + + +### MediaGalleryEntry + +Defines characteristics about images and videos associated with a specific product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](#string) | The path of the image on the server. | +| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](#string) | Either `image` or `video`. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | + +#### Example + +```json +{ + "content": ProductMediaGalleryEntriesContent, + "disabled": true, + "file": "abc123", + "id": 123, + "label": "abc123", + "media_type": "abc123", + "position": 987, + "types": ["xyz789"], + "uid": 4, + "video_content": ProductMediaGalleryEntriesVideoContent +} +``` + + + +### MediaGalleryInterface + +Contains basic information about a product image or video. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Possible Types + +| MediaGalleryInterface Types | +|----------------| +| [`ProductImage`](#productimage) | +| [`ProductVideo`](#productvideo) | + +#### Example + +```json +{ + "disabled": false, + "label": "xyz789", + "position": 123, + "url": "abc123" +} +``` + + + +### Money + +Defines a monetary value, including a numeric value and a currency code. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](#float) | A number expressing a monetary value. | + +#### Example + +```json +{"currency": "AFN", "value": 987.65} +``` + + + +### MoveCartItemsToGiftRegistryOutput + +Contains the customer's gift registry and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | + +#### Example + +```json +{ + "gift_registry": GiftRegistry, + "status": false, + "user_errors": [GiftRegistryItemsUserError] +} +``` + + + +### MoveItemsBetweenRequisitionListsInput + +An input object that defines the items in a requisition list to be moved. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | + +#### Example + +```json +{"requisitionListItemUids": ["4"]} +``` + + + +### MoveItemsBetweenRequisitionListsOutput + +Output of the request to move items to another requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | + +#### Example + +```json +{ + "destination_requisition_list": RequisitionList, + "source_requisition_list": RequisitionList +} +``` + + + +### MoveProductsBetweenWishlistsOutput + +Contains the source and target wish lists after moving products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | + +#### Example + +```json +{ + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] +} +``` + + + +### NegotiableQuote + +Contains details about a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](#string) | The email address of the company user. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | +| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | + +#### Example + +```json +{ + "available_payment_methods": [AvailablePaymentMethod], + "billing_address": NegotiableQuoteBillingAddress, + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "created_at": "xyz789", + "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" +} +``` + + + +### NegotiableQuoteAddressCountry + +Defines the company's country. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The address country code. | +| `label` - [`String!`](#string) | The display name of the region. | + +#### Example + +```json +{ + "code": "abc123", + "label": "xyz789" +} +``` + + + +### NegotiableQuoteAddressInput + +Defines the billing or shipping address to be applied to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company name. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | + +#### Example + +```json +{ + "city": "abc123", + "company": "xyz789", + "country_code": "xyz789", + "firstname": "abc123", + "lastname": "abc123", + "postcode": "xyz789", + "region": "xyz789", + "region_id": 987, + "save_in_address_book": true, + "street": ["abc123"], + "telephone": "xyz789" +} +``` + + + +### NegotiableQuoteAddressInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | + +#### Possible Types + +| NegotiableQuoteAddressInterface Types | +|----------------| +| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | +| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | + +#### Example + +```json +{ + "city": "xyz789", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "street": ["xyz789"], + "telephone": "xyz789" +} +``` + + + +### NegotiableQuoteAddressRegion + +Defines the company's state or province. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The address region code. | +| `label` - [`String`](#string) | The display name of the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | + +#### Example + +```json +{ + "code": "xyz789", + "label": "xyz789", + "region_id": 123 +} +``` + + + +### NegotiableQuoteBillingAddress + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | + +#### Example + +```json +{ + "city": "xyz789", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "xyz789", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "street": ["abc123"], + "telephone": "abc123" +} +``` + + + +### NegotiableQuoteBillingAddressInput + +Defines the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | + +#### Example + +```json +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": 4, + "same_as_shipping": false, + "use_for_shipping": true +} +``` + + + +### NegotiableQuoteComment + +Contains a single plain text comment from either the buyer or seller. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | +| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | +| `text` - [`String!`](#string) | The plain text comment. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | + +#### Example + +```json +{ + "author": NegotiableQuoteUser, + "created_at": "abc123", + "creator_type": "BUYER", + "text": "abc123", + "uid": "4" +} +``` + + + +### NegotiableQuoteCommentCreatorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BUYER` | | +| `SELLER` | | + +#### Example + +```json +""BUYER"" +``` + + + +### NegotiableQuoteCommentInput + +Contains the commend provided by the buyer. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The comment provided by the buyer. | + +#### Example + +```json +{"comment": "xyz789"} +``` + + + +### NegotiableQuoteCustomLogChange + +Contains custom log entries added by third-party extensions. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `new_value` - [`String!`](#string) | The new entry content. | +| `old_value` - [`String`](#string) | The previous entry in the custom log. | +| `title` - [`String!`](#string) | The title of the custom log entry. | + +#### Example + +```json +{ + "new_value": "abc123", + "old_value": "abc123", + "title": "xyz789" +} +``` + + + +### NegotiableQuoteFilterInput + +Defines a filter to limit the negotiable quotes to return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | + +#### Example + +```json +{ + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput +} +``` + + + +### NegotiableQuoteHistoryChanges + +Contains a list of changes to a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | + +#### Example + +```json +{ + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange +} +``` + + + +### NegotiableQuoteHistoryCommentChange + +Contains a comment submitted by a seller or buyer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | + +#### Example + +```json +{"comment": "abc123"} +``` + + + +### NegotiableQuoteHistoryEntry + +Contains details about a change for a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | +| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | +| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | + +#### Example + +```json +{ + "author": NegotiableQuoteUser, + "change_type": "CREATED", + "changes": NegotiableQuoteHistoryChanges, + "created_at": "abc123", + "uid": "4" +} +``` + + + +### NegotiableQuoteHistoryEntryChangeType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CREATED` | | +| `UPDATED` | | +| `CLOSED` | | +| `UPDATED_BY_SYSTEM` | | + +#### Example + +```json +""CREATED"" +``` + + + +### NegotiableQuoteHistoryExpirationChange + +Contains a new expiration date and the previous date. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | + +#### Example + +```json +{ + "new_expiration": "abc123", + "old_expiration": "xyz789" +} +``` + + + +### NegotiableQuoteHistoryProductsRemovedChange + +Contains lists of products that have been removed from the catalog and negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | + +#### Example + +```json +{ + "products_removed_from_catalog": ["4"], + "products_removed_from_quote": [ProductInterface] +} +``` + + + +### NegotiableQuoteHistoryStatusChange + +Lists a new status change applied to a negotiable quote and the previous status. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | +| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | + +#### Example + +```json +{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} +``` + + + +### NegotiableQuoteHistoryStatusesChange + +Contains a list of status changes that occurred for the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | + +#### Example + +```json +{"changes": [NegotiableQuoteHistoryStatusChange]} +``` + + + +### NegotiableQuoteHistoryTotalChange + +Contains a new price and the previous price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `new_price` - [`Money`](#money) | The total price as a result of the change. | +| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | + +#### Example + +```json +{ + "new_price": Money, + "old_price": Money +} +``` + + + +### NegotiableQuoteInvalidStateError + +An error indicating that an operation was attempted on a negotiable quote in an invalid state. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | + +#### Example + +```json +{"message": "xyz789"} +``` + + + +### NegotiableQuoteItemQuantityInput + +Specifies the updated quantity of an item. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | + +#### Example + +```json +{"quantity": 987.65, "quote_item_uid": "4"} +``` + + + +### NegotiableQuotePaymentMethodInput + +Defines the payment method to be applied to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`String!`](#string) | Payment method code | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | + +#### Example + +```json +{ + "code": "abc123", + "purchase_order_number": "xyz789" +} +``` + + + +### NegotiableQuoteShippingAddress + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | + +#### Example + +```json +{ + "available_shipping_methods": [AvailableShippingMethod], + "city": "abc123", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "xyz789", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "telephone": "abc123" +} +``` + + + +### NegotiableQuoteShippingAddressInput + +Defines shipping addresses for the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | + +#### Example + +```json +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "customer_notes": "xyz789" +} +``` + + + +### NegotiableQuoteSortInput + +Defines the field to use to sort a list of negotiable quotes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | + +#### Example + +```json +{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} +``` + + + +### NegotiableQuoteSortableField + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""QUOTE_NAME"" +``` + + + +### NegotiableQuoteStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUBMITTED` | | +| `PENDING` | | +| `UPDATED` | | +| `OPEN` | | +| `ORDERED` | | +| `CLOSED` | | +| `DECLINED` | | +| `EXPIRED` | | + +#### Example + +```json +""SUBMITTED"" +``` + + + +### NegotiableQuoteUidNonFatalResultInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Possible Types + +| NegotiableQuoteUidNonFatalResultInterface Types | +|----------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | + +#### Example + +```json +{"quote_uid": 4} +``` + + + +### NegotiableQuoteUidOperationSuccess + +Contains details about a successful operation on a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"quote_uid": 4} +``` + + + +### NegotiableQuoteUser + +A limited view of a Buyer or Seller in the negotiable quote process. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | + +#### Example + +```json +{ + "firstname": "abc123", + "lastname": "xyz789" +} +``` + + + +### NegotiableQuotesOutput + +Contains a list of negotiable that match the specified filter. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | + +#### Example + +```json +{ + "items": [NegotiableQuote], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 +} +``` + + + +### NoSuchEntityUidError + +Contains an error message when an invalid UID was specified. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | + +#### Example + +```json +{ + "message": "abc123", + "uid": "4" +} +``` + + + +### Order + +Contains the order ID. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | + +#### Example + +```json +{ + "order_id": "abc123", + "order_number": "xyz789" +} +``` + + + +### OrderAddress + +Contains detailed information about an order's billing and shipping addresses. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `fax` - [`String`](#string) | The fax number. | +| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | The state or province name. | +| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | + +#### Example + +```json +{ + "city": "xyz789", + "company": "xyz789", + "country_code": "AF", + "fax": "abc123", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "abc123", + "region": "abc123", + "region_id": 4, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" +} +``` + + + +### OrderItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "discounts": [Discount], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} +``` + + + +### OrderItemInterface + +Order item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Possible Types + +| OrderItemInterface Types | +|----------------| +| [`DownloadableOrderItem`](#downloadableorderitem) | +| [`BundleOrderItem`](#bundleorderitem) | +| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`OrderItem`](#orderitem) | + +#### Example + +```json +{ + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "product_name": "xyz789", + "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": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "abc123" +} +``` + + + +### OrderItemOption + +Represents order item options like selected or entered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The name of the option. | +| `value` - [`String!`](#string) | The value of the option. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### OrderPaymentMethod + +Contains details about the payment method used to pay for the order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | +| `name` - [`String!`](#string) | The label that describes the payment method. | +| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | + +#### Example + +```json +{ + "additional_data": [KeyValue], + "name": "xyz789", + "type": "abc123" +} +``` + + + +### OrderShipment + +Contains order shipment details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "id": "4", + "items": [ShipmentItemInterface], + "number": "xyz789", + "tracking": [ShipmentTracking] +} +``` + + + +### OrderTotal + +Contains details about the sales total amounts used to calculate the final price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | +| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | +| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | + +#### Example + +```json +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_giftcard": Money, + "total_shipping": Money, + "total_tax": Money +} +``` + + + +### PayflowExpressInput + +Contains required input for Payflow Express Checkout payments. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | + +#### Example + +```json +{ + "payer_id": "abc123", + "token": "xyz789" +} +``` + + + +### PayflowLinkInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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!`](#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 + +```json +{ + "cancel_url": "abc123", + "error_url": "xyz789", + "return_url": "xyz789" +} +``` + + + +### PayflowLinkMode + +Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TEST` | | +| `LIVE` | | + +#### Example + +```json +""TEST"" +``` + + + +### PayflowLinkToken + +Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | +| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | + +#### Example + +```json +{ + "mode": "TEST", + "paypal_url": "xyz789", + "secure_token": "abc123", + "secure_token_id": "abc123" +} +``` + + + +### PayflowLinkTokenInput + +Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### PayflowProInput + +Contains input for the Payflow Pro and Payments Pro payment methods. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](#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 + +```json +{ + "cc_details": CreditCardDetailsInput, + "is_active_payment_token_enabler": true +} +``` + + + +### PayflowProResponseInput + +Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "paypal_payload": "xyz789" +} +``` + + + +### PayflowProResponseOutput + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### PayflowProTokenInput + +Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | + +#### Example + +```json +{ + "cart_id": "abc123", + "urls": PayflowProUrlInput +} +``` + + + +### PayflowProUrlInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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!`](#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 + +```json +{ + "cancel_url": "xyz789", + "error_url": "abc123", + "return_url": "xyz789" +} +``` + + + +### PaymentMethodInput + +Defines the payment method. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `braintree` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | +| `code` - [`String!`](#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | +| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | +| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | +| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | + +#### Example + +```json +{ + "braintree": BraintreeInput, + "braintree_cc_vault": BraintreeCcVaultInput, + "code": "abc123", + "hosted_pro": HostedProInput, + "payflow_express": PayflowExpressInput, + "payflow_link": PayflowLinkInput, + "payflowpro": PayflowProInput, + "payflowpro_cc_vault": VaultTokenInput, + "paypal_express": PaypalExpressInput, + "purchase_order_number": "xyz789" +} +``` + + + +### PaymentToken + +The stored payment method available to the customer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `details` - [`String`](#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](#string) | The public hash of the token. | +| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | + +#### Example + +```json +{ + "details": "xyz789", + "payment_method_code": "abc123", + "public_hash": "abc123", + "type": "card" +} +``` + + + +### PaymentTokenTypeEnum + +The list of available payment token types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | + +#### Example + +```json +""card"" +``` + + + +### PaypalExpressInput + +Contains required input for Express Checkout and Payments Standard payments. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | + +#### Example + +```json +{ + "payer_id": "xyz789", + "token": "abc123" +} +``` + + + +### PaypalExpressTokenInput + +Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](#string) | The payment method code. | +| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | +| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | + +#### Example + +```json +{ + "cart_id": "abc123", + "code": "abc123", + "express_button": false, + "urls": PaypalExpressUrlsInput, + "use_paypal_credit": true +} +``` + + + +### PaypalExpressTokenOutput + +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 Name | Description | +|------------|-------------| +| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | +| `token` - [`String`](#string) | The token returned by PayPal. | + +#### Example + +```json +{ + "paypal_urls": PaypalExpressUrlList, + "token": "abc123" +} +``` + + + +### PaypalExpressUrlList + +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 Name | Description | +|------------|-------------| +| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](#string) | The URL to the PayPal login page. | + +#### Example + +```json +{ + "edit": "xyz789", + "start": "abc123" +} +``` + + + +### PaypalExpressUrlsInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 + +```json +{ + "cancel_url": "abc123", + "pending_url": "abc123", + "return_url": "abc123", + "success_url": "abc123" +} +``` + + + +### PhysicalProductInterface + +Contains attributes specific to tangible products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Possible Types + +| PhysicalProductInterface Types | +|----------------| +| [`SimpleProduct`](#simpleproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`ConfigurableProduct`](#configurableproduct) | + +#### Example + +```json +{"weight": 987.65} +``` + + + +### PickupLocation + +Defines Pickup Location information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String`](#string) | | +| `contact_name` - [`String`](#string) | | +| `country_id` - [`String`](#string) | | +| `description` - [`String`](#string) | | +| `email` - [`String`](#string) | | +| `fax` - [`String`](#string) | | +| `latitude` - [`Float`](#float) | | +| `longitude` - [`Float`](#float) | | +| `name` - [`String`](#string) | | +| `phone` - [`String`](#string) | | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | | +| `region` - [`String`](#string) | | +| `region_id` - [`Int`](#int) | | +| `street` - [`String`](#string) | | + +#### Example + +```json +{ + "city": "xyz789", + "contact_name": "xyz789", + "country_id": "abc123", + "description": "xyz789", + "email": "abc123", + "fax": "abc123", + "latitude": 987.65, + "longitude": 987.65, + "name": "xyz789", + "phone": "abc123", + "pickup_location_code": "xyz789", + "postcode": "abc123", + "region": "abc123", + "region_id": 123, + "street": "xyz789" +} +``` + + + +### PickupLocationFilterInput + +PickupLocationFilterInput defines the list of attributes and filters for the search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | + +#### Example + +```json +{ + "city": FilterTypeInput, + "country_id": FilterTypeInput, + "name": FilterTypeInput, + "pickup_location_code": FilterTypeInput, + "postcode": FilterTypeInput, + "region": FilterTypeInput, + "region_id": FilterTypeInput, + "street": FilterTypeInput +} +``` + + + +### PickupLocationSortInput + +PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | +| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | + +#### Example + +```json +{ + "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" +} +``` + + + +### PickupLocations + +Top level object returned in a pickup locations search. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](#int) | The number of products returned. | + +#### Example + +```json +{ + "items": [PickupLocation], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### PlaceNegotiableQuoteOrderInput + +Specifies the negotiable quote to convert to an order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"quote_uid": 4} +``` + + + +### PlaceNegotiableQuoteOrderOutput + +An output object that returns the generated order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `order` - [`Order!`](#order) | Contains the generated order number. | + +#### Example + +```json +{"order": Order} +``` + + + +### PlaceOrderForPurchaseOrderInput + +Specifies the purchase order to convert to an order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | + +#### Example + +```json +{"purchase_order_uid": "4"} +``` + + + +### PlaceOrderForPurchaseOrderOutput + +Contains the results of the request to place an order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | + +#### Example + +```json +{"order": CustomerOrder} +``` + + + +### PlaceOrderInput + +Specifies the quote to be converted to an order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### PlaceOrderOutput + +Contains the results of the request to place an order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `order` - [`Order!`](#order) | The ID of the order. | + +#### Example + +```json +{"order": Order} +``` + + + +### PlacePurchaseOrderInput + +Specifies the quote to be converted to a purchase order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### PlacePurchaseOrderOutput + +Contains the results of the request to place a purchase order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | + +#### Example + +```json +{"purchase_order": PurchaseOrder} +``` + + + +### Price + +Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | +| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | + +#### Example + +```json +{ + "adjustments": [PriceAdjustment], + "amount": Money +} +``` + + + +### PriceAdjustment + +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 Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | +| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | +| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | + +#### Example + +```json +{ + "amount": Money, + "code": "TAX", + "description": "INCLUDED" +} +``` + + + +### PriceAdjustmentCodesEnum + +`PriceAdjustment.code` is deprecated. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | +| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | +| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | + +#### Example + +```json +""TAX"" +``` + + + +### PriceAdjustmentDescriptionEnum + +`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INCLUDED` | | +| `EXCLUDED` | | + +#### Example + +```json +""INCLUDED"" +``` + + + +### PriceRange + +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 Name | Description | +|------------|-------------| +| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | +| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | + +#### Example + +```json +{ + "maximum_price": ProductPrice, + "minimum_price": ProductPrice +} +``` + + + +### PriceTypeEnum + +Defines the price type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FIXED` | | +| `PERCENT` | | +| `DYNAMIC` | | + +#### Example + +```json +""FIXED"" +``` + + + +### PriceViewEnum + +Defines whether a bundle product's price is displayed as the lowest possible value or as a range. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRICE_RANGE` | | +| `AS_LOW_AS` | | + +#### Example + +```json +""PRICE_RANGE"" +``` + + + +### ProductAttribute + +Contains a product attribute code and value. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](#string) | The display value of the attribute. | + +#### Example + +```json +{ + "code": "xyz789", + "value": "abc123" +} +``` + + + +### ProductAttributeFilterInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `activity` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Activity | +| `category_gear` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Category Gear | +| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `climate` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Climate | +| `collar` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Collar | +| `color` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Color | +| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | +| `eco_collection` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Eco Collection | +| `erin_recommends` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Erin Recommends | +| `features_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Features | +| `format` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Format | +| `gender` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Gender | +| `material` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Material | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | +| `new` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: New | +| `pattern` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Pattern | +| `performance_fabric` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Performance Fabric | +| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | +| `purpose` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Purpose | +| `sale` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sale | +| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | +| `size` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Size | +| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | +| `sleeve` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sleeve | +| `strap_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Strap/Handle | +| `style_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bags | +| `style_bottom` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bottom | +| `style_general` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style General | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | + +#### Example + +```json +{ + "activity": FilterEqualTypeInput, + "category_gear": FilterEqualTypeInput, + "category_id": FilterEqualTypeInput, + "category_uid": 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 +} +``` + + + +### ProductAttributeSortInput + +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 + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | + +#### Example + +```json +{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} +``` + + + +### ProductDiscount + +Contains the discount applied to a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount_off` - [`Float`](#float) | The actual value of the discount. | +| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | + +#### Example + +```json +{"amount_off": 123.45, "percent_off": 987.65} +``` + + + +### ProductFilterInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | +| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "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 +} +``` + + + +### ProductImage + +Contains product image information, including the image URL and label. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Example + +```json +{ + "disabled": true, + "label": "xyz789", + "position": 123, + "url": "xyz789" +} +``` + + + +### ProductInfoInput + +Product Information used for Pickup Locations search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `sku` - [`String!`](#string) | Product SKU. | + +#### Example + +```json +{"sku": "xyz789"} +``` + + + +### ProductInterface + +Contains fields that are common to all types of products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Possible Types + +| ProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`ConfigurableProduct`](#configurableproduct) | + +#### Example + +```json +{ + "activity": "abc123", + "attribute_set_id": 987, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "xyz789", + "climate": "abc123", + "collar": "abc123", + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "eco_collection": 123, + "erin_recommends": 987, + "features_bags": "abc123", + "format": 987, + "gender": "xyz789", + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "material": "abc123", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, + "options_container": "xyz789", + "pattern": "abc123", + "performance_fabric": 123, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 987, + "rating_summary": 987.65, + "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, + "sale": 987, + "short_description": ComplexTextValue, + "size": 987, + "sku": "xyz789", + "sleeve": "xyz789", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "strap_bags": "abc123", + "style_bags": "xyz789", + "style_bottom": "xyz789", + "style_general": "xyz789", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "tier_price": 123.45, + "tier_prices": [ProductTierPrices], + "type_id": "xyz789", + "uid": 4, + "updated_at": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website] +} +``` + + + +### ProductLinks + +An implementation of `ProductLinksInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | + +#### Example + +```json +{ + "link_type": "abc123", + "linked_product_sku": "abc123", + "linked_product_type": "abc123", + "position": 123, + "sku": "xyz789" +} +``` + + + +### ProductLinksInterface + +Contains information about linked products, including the link type and product type of each item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | + +#### Possible Types + +| ProductLinksInterface Types | +|----------------| +| [`ProductLinks`](#productlinks) | + +#### Example + +```json +{ + "link_type": "abc123", + "linked_product_sku": "xyz789", + "linked_product_type": "abc123", + "position": 123, + "sku": "abc123" +} +``` + + + +### ProductMediaGalleryEntriesContent + +Contains an image in base64 format and basic information about the image. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | +| `name` - [`String`](#string) | The file name of the image. | +| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | + +#### Example + +```json +{ + "base64_encoded_data": "xyz789", + "name": "abc123", + "type": "xyz789" +} +``` + + + +### ProductMediaGalleryEntriesVideoContent + +Contains a link to a video file and basic information about the video. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `media_type` - [`String`](#string) | Must be external-video. | +| `video_description` - [`String`](#string) | A description of the video. | +| `video_metadata` - [`String`](#string) | Optional data about the video. | +| `video_provider` - [`String`](#string) | Describes the video source. | +| `video_title` - [`String`](#string) | The title of the video. | +| `video_url` - [`String`](#string) | The URL to the video. | + +#### Example + +```json +{ + "media_type": "abc123", + "video_description": "xyz789", + "video_metadata": "abc123", + "video_provider": "abc123", + "video_title": "xyz789", + "video_url": "xyz789" +} +``` + + + +### ProductPrice + +Represents a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | +| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `regular_price` - [`Money!`](#money) | The regular price of the product. | + +#### Example + +```json +{ + "discount": ProductDiscount, + "final_price": Money, + "fixed_product_taxes": [FixedProductTax], + "regular_price": Money +} +``` + + + +### ProductPrices + +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 Name | Description | +|------------|-------------| +| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | +| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | +| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | + +#### Example + +```json +{ + "maximalPrice": Price, + "minimalPrice": Price, + "regularPrice": Price +} +``` + + + +### ProductReview + +Contains details of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](#string) | The date the review was created. | +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | +| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | + +#### Example + +```json +{ + "average_rating": 987.65, + "created_at": "xyz789", + "nickname": "abc123", + "product": ProductInterface, + "ratings_breakdown": [ProductReviewRating], + "summary": "abc123", + "text": "xyz789" +} +``` + + + +### ProductReviewRating + +Contains data about a single aspect of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | + +#### Example + +```json +{ + "name": "abc123", + "value": "abc123" +} +``` + + + +### ProductReviewRatingInput + +Contains the reviewer's rating for a single aspect of a review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`String!`](#string) | An encoded rating ID. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | + +#### Example + +```json +{ + "id": "abc123", + "value_id": "abc123" +} +``` + + + +### ProductReviewRatingMetadata + +Contains details about a single aspect of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`String!`](#string) | An encoded rating ID. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | + +#### Example + +```json +{ + "id": "abc123", + "name": "abc123", + "values": [ProductReviewRatingValueMetadata] +} +``` + + + +### ProductReviewRatingValueMetadata + +Contains details about a single value in a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | + +#### Example + +```json +{ + "value": "abc123", + "value_id": "abc123" +} +``` + + + +### ProductReviewRatingsMetadata + +Contains an array of metadata about each aspect of a product review. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | + +#### Example + +```json +{"items": [ProductReviewRatingMetadata]} +``` + + + +### ProductReviews + +Contains an array of product reviews. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | + +#### Example + +```json +{ + "items": [ProductReview], + "page_info": SearchResultPageInfo +} +``` + + + +### ProductStockStatus + +This enumeration states whether a product stock status is in stock or out of stock + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `IN_STOCK` | | +| `OUT_OF_STOCK` | | + +#### Example + +```json +""IN_STOCK"" +``` + + + +### ProductTierPrices + +Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | + +#### Example + +```json +{ + "customer_group_id": "abc123", + "percentage_value": 987.65, + "qty": 987.65, + "value": 987.65, + "website_id": 987.65 +} +``` + + + +### ProductVideo + +Contains information about a product video. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | + +#### Example + +```json +{ + "disabled": false, + "label": "xyz789", + "position": 987, + "url": "abc123", + "video_content": ProductMediaGalleryEntriesVideoContent +} +``` + + + +### Products + +Contains the results of a `products` query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](#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 + +```json +{ + "aggregations": [Aggregation], + "filters": [LayerFilter], + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "suggestions": [SearchSuggestion], + "total_count": 987 +} +``` + + + +### PurchaseOrder + +Contains details about a purchase order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | +| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | +| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | +| `created_at` - [`String!`](#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | +| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | +| `number` - [`String!`](#string) | The purchase order number. | +| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | +| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | +| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | + +#### Example + +```json +{ + "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" +} +``` + + + +### PurchaseOrderAction + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `REJECT` | | +| `CANCEL` | | +| `VALIDATE` | | +| `APPROVE` | | +| `PLACE_ORDER` | | + +#### Example + +```json +""REJECT"" +``` + + + +### PurchaseOrderActionError + +Contains details about a failed action. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | + +#### Example + +```json +{"message": "xyz789", "type": "NOT_FOUND"} +``` + + + +### PurchaseOrderApprovalFlowEvent + +Contains details about a single event in the approval flow of the purchase order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | A formatted message. | +| `name` - [`String`](#string) | The approver name. | +| `role` - [`String`](#string) | The approver role. | +| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | +| `updated_at` - [`String`](#string) | The date and time the event was updated. | + +#### Example + +```json +{ + "message": "abc123", + "name": "abc123", + "role": "abc123", + "status": "PENDING", + "updated_at": "xyz789" +} +``` + + + +### PurchaseOrderApprovalFlowItemStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVED` | | +| `REJECTED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### PurchaseOrderApprovalRule + +Contains details about a purchase order approval rule. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | +| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](#string) | The name of the purchase order approval rule. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | + +#### Example + +```json +{ + "applies_to_roles": [CompanyRole], + "approver_roles": [CompanyRole], + "condition": PurchaseOrderApprovalRuleConditionInterface, + "created_at": "xyz789", + "created_by": "abc123", + "description": "abc123", + "name": "abc123", + "status": "ENABLED", + "uid": "4", + "updated_at": "xyz789" +} +``` + + + +### PurchaseOrderApprovalRuleConditionAmount + +Contains approval rule condition details, including the amount to be evaluated. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | + +#### Example + +```json +{ + "amount": Money, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN" +} +``` + + + +### PurchaseOrderApprovalRuleConditionInterface + +Purchase order rule condition details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | + +#### Possible Types + +| PurchaseOrderApprovalRuleConditionInterface Types | +|----------------| +| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | +| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | + +#### Example + +```json +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} +``` + + + +### PurchaseOrderApprovalRuleConditionOperator + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `MORE_THAN` | | +| `LESS_THAN` | | +| `MORE_THAN_OR_EQUAL_TO` | | +| `LESS_THAN_OR_EQUAL_TO` | | + +#### Example + +```json +""MORE_THAN"" +``` + + + +### PurchaseOrderApprovalRuleConditionQuantity + +Contains approval rule condition details, including the quantity to be evaluated. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | + +#### Example + +```json +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +``` + + + +### PurchaseOrderApprovalRuleInput + +Defines a new purchase order approval rule. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](#string) | The purchase order approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | + +#### Example + +```json +{ + "applies_to": [4], + "approvers": ["4"], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "xyz789", + "name": "abc123", + "status": "ENABLED" +} +``` + + + +### PurchaseOrderApprovalRuleMetadata + +Contains metadata that can be used to render rule edit forms. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | + +#### Example + +```json +{ + "available_applies_to": [CompanyRole], + "available_condition_currencies": [AvailableCurrency], + "available_requires_approval_from": [CompanyRole] +} +``` + + + +### PurchaseOrderApprovalRuleStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ENABLED` | | +| `DISABLED` | | + +#### Example + +```json +""ENABLED"" +``` + + + +### PurchaseOrderApprovalRuleType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `GRAND_TOTAL` | | +| `SHIPPING_INCL_TAX` | | +| `NUMBER_OF_SKUS` | | + +#### Example + +```json +""GRAND_TOTAL"" +``` + + + +### PurchaseOrderApprovalRules + +Contains the approval rules that the customer can see. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | + +#### Example + +```json +{ + "items": [PurchaseOrderApprovalRule], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### PurchaseOrderComment + +Contains details about a comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author` - [`Customer`](#customer) | The user who left the comment. | +| `created_at` - [`String!`](#string) | The date and time when the comment was created. | +| `text` - [`String!`](#string) | The text of the comment. | +| `uid` - [`ID!`](#id) | A unique identifier of the comment. | + +#### Example + +```json +{ + "author": Customer, + "created_at": "abc123", + "text": "xyz789", + "uid": 4 +} +``` + + + +### PurchaseOrderErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | + +#### Example + +```json +""NOT_FOUND"" +``` + + + +### PurchaseOrderHistoryItem + +Contains details about a status change. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String!`](#string) | The activity type of the event. | +| `created_at` - [`String!`](#string) | The date and time when the event happened. | +| `message` - [`String!`](#string) | The message representation of the event. | +| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | + +#### Example + +```json +{ + "activity": "xyz789", + "created_at": "xyz789", + "message": "abc123", + "uid": 4 +} +``` + + + +### PurchaseOrderRuleApprovalFlow + +Contains details about approval roles applied to the purchase order and status changes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | +| `rule_name` - [`String!`](#string) | The name of the applied rule. | + +#### Example + +```json +{ + "events": [PurchaseOrderApprovalFlowEvent], + "rule_name": "xyz789" +} +``` + + + +### PurchaseOrderStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVAL_REQUIRED` | | +| `APPROVED` | | +| `ORDER_IN_PROGRESS` | | +| `ORDER_PLACED` | | +| `ORDER_FAILED` | | +| `REJECTED` | | +| `CANCELED` | | +| `APPROVED_PENDING_PAYMENT` | | + +#### Example + +```json +""PENDING"" +``` + + + +### PurchaseOrders + +Contains a list of purchase orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | + +#### Example + +```json +{ + "items": [PurchaseOrder], + "page_info": SearchResultPageInfo, + "total_count": 987 +} +``` + + + +### PurchaseOrdersActionInput + +Defines which purchase orders to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of of purchase order UIDs. | + +#### Example + +```json +{"purchase_order_uids": [4]} +``` + + + +### PurchaseOrdersActionOutput + +Returns a list of updated purchase orders and any error messages. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | + +#### Example + +```json +{ + "errors": [PurchaseOrderActionError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### PurchaseOrdersFilterInput + +Defines the criteria to use to filter the list of purchase orders. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | + +#### Example + +```json +{ + "company_purchase_orders": false, + "created_date": FilterRangeTypeInput, + "require_my_approval": false, + "status": "PENDING" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-q-s.md new file mode 100644 index 000000000..015559e11 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-q-s.md @@ -0,0 +1,3253 @@ +## Types + +### Region + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | +| `id` - [`Int`](#int) | The unique ID for a `Region` object. | +| `name` - [`String`](#string) | The name of the region, such as Texas. | + +#### Example + +```json +{ + "code": "abc123", + "id": 987, + "name": "xyz789" +} +``` + + + +### RemoveCouponFromCartInput + +Specifies the cart from which to remove a coupon. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### RemoveCouponFromCartOutput + +Contains details about the cart after removing a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveGiftCardFromCartInput + +Defines the input required to run the `removeGiftCardFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_card_code": "abc123" +} +``` + + + +### RemoveGiftCardFromCartOutput + +Defines the possible output for the `removeGiftCardFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveGiftRegistryItemsOutput + +Contains the results of a request to remove an item from a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveGiftRegistryOutput + +Contains the results of a request to delete a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | + +#### Example + +```json +{"success": false} +``` + + + +### RemoveGiftRegistryRegistrantsOutput + +Contains the results of a request to delete a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveItemFromCartInput + +Specifies which items to remove from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_item_id": 987, + "cart_item_uid": "4" +} +``` + + + +### RemoveItemFromCartOutput + +Contains details about the cart after removing an item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after removing an item. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveNegotiableQuoteItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"quote_item_uids": [4], "quote_uid": 4} +``` + + + +### RemoveNegotiableQuoteItemsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RemoveProductsFromCompareListInput + +Defines which products to remove from a compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": ["4"], "uid": 4} +``` + + + +### RemoveProductsFromWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### RemoveReturnTrackingInput + +Defines the tracking information to delete. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | + +#### Example + +```json +{"return_shipping_tracking_uid": "4"} +``` + + + +### RemoveReturnTrackingOutput + +Contains the response after deleting tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Contains details about the modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### RemoveRewardPointsFromCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveStoreCreditFromCartInput + +Defines the input required to run the `removeStoreCreditFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### RemoveStoreCreditFromCartOutput + +Defines the possible output for the `removeStoreCreditFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ReorderItemsOutput + +Contains the cart and any errors after adding products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | + +#### Example + +```json +{ + "cart": Cart, + "userInputErrors": [CheckoutUserInputError] +} +``` + + + +### RequestNegotiableQuoteInput + +Defines properties of a negotiable quote request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | + +#### Example + +```json +{ + "cart_id": 4, + "comment": NegotiableQuoteCommentInput, + "quote_name": "xyz789" +} +``` + + + +### RequestNegotiableQuoteOutput + +Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RequestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | + +#### Example + +```json +{ + "comment_text": "xyz789", + "contact_email": "abc123", + "items": [RequestReturnItemInput], + "order_uid": "4" +} +``` + + + +### RequestReturnItemInput + +Contains details about an item to be returned. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | +| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 + +```json +{ + "entered_custom_attributes": [ + EnteredCustomAttributeInput + ], + "order_item_uid": 4, + "quantity_to_return": 987.65, + "selected_custom_attributes": [ + SelectedCustomAttributeInput + ] +} +``` + + + +### RequestReturnOutput + +Contains the response to a return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about a single return request. | +| `returns` - [`Returns`](#returns) | An array of return requests. | + +#### Example + +```json +{ + "return": Return, + "returns": Returns +} +``` + + + +### RequisitionList + +Defines the contents of a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `description` - [`String`](#string) | Optional text that describes the requisition list. | +| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | +| `items_count` - [`Int!`](#int) | The number of items in the list. | +| `name` - [`String!`](#string) | The requisition list name. | +| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | + +#### Example + +```json +{ + "description": "abc123", + "items": RequistionListItems, + "items_count": 987, + "name": "xyz789", + "uid": "4", + "updated_at": "xyz789" +} +``` + + + +### RequisitionListFilterInput + +Defines requisition list filters. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | + +#### Example + +```json +{ + "name": FilterMatchTypeInput, + "uids": FilterEqualTypeInput +} +``` + + + +### RequisitionListItemInterface + +The interface for requisition list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Possible Types + +| RequisitionListItemInterface Types | +|----------------| +| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | +| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### RequisitionListItemsInput + +Defines the items to add. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | +| `quantity` - [`Float`](#float) | The quantity of the product to add. | +| `selected_options` - [`[String]`](#string) | Selected option IDs. | +| `sku` - [`String!`](#string) | The product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 123.45, + "selected_options": ["abc123"], + "sku": "abc123" +} +``` + + + +### RequisitionLists + +Defines customer requisition lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The number of returned requisition lists. | + +#### Example + +```json +{ + "items": [RequisitionList], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### RequistionListItems + +Contains an array of items added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_pages` - [`Int!`](#int) | The number of pages returned. | + +#### Example + +```json +{ + "items": [RequisitionListItemInterface], + "page_info": SearchResultPageInfo, + "total_pages": 123 +} +``` + + + +### Return + +Contains details about a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | +| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | +| `created_at` - [`String!`](#string) | The date the return was requested. | +| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | +| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | +| `number` - [`String!`](#string) | A human-readable return number. | +| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | +| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | +| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | +| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "available_shipping_carriers": [ReturnShippingCarrier], + "comments": [ReturnComment], + "created_at": "abc123", + "customer": ReturnCustomer, + "items": [ReturnItem], + "number": "abc123", + "order": CustomerOrder, + "shipping": ReturnShipping, + "status": "PENDING", + "uid": 4 +} +``` + + + +### ReturnComment + +Contains details about a return comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author_name` - [`String!`](#string) | The name or author who posted the comment. | +| `created_at` - [`String!`](#string) | The date and time the comment was posted. | +| `text` - [`String!`](#string) | The contents of the comment. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | + +#### Example + +```json +{ + "author_name": "xyz789", + "created_at": "xyz789", + "text": "abc123", + "uid": 4 +} +``` + + + +### ReturnCustomAttribute + +Contains details about a `ReturnCustomerAttribute` object. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the attribute. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | + +#### Example + +```json +{ + "label": "abc123", + "uid": 4, + "value": "abc123" +} +``` + + + +### ReturnCustomer + +The customer information for the return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the customer. | +| `firstname` - [`String`](#string) | The first name of the customer. | +| `lastname` - [`String`](#string) | The last name of the customer. | + +#### Example + +```json +{ + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### ReturnItem + +Contains details about a product being returned. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | +| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | + +#### Example + +```json +{ + "custom_attributes": [ReturnCustomAttribute], + "order_item": OrderItemInterface, + "quantity": 987.65, + "request_quantity": 123.45, + "status": "PENDING", + "uid": 4 +} +``` + + + +### ReturnItemStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `RECEIVED` | | +| `APPROVED` | | +| `REJECTED` | | +| `DENIED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### ReturnShipping + +Contains details about the return shipping address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | +| `tracking` - [`[ReturnShippingTracking]`](#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. | + +#### Example + +```json +{ + "address": ReturnShippingAddress, + "tracking": [ReturnShippingTracking] +} +``` + + + +### ReturnShippingAddress + +Contains details about the shipping address used for receiving returned items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city for product returns. | +| `contact_name` - [`String`](#string) | The merchant's contact person. | +| `country` - [`Country!`](#country) | An object that defines the country for product returns. | +| `postcode` - [`String!`](#string) | The postal code for product returns. | +| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | +| `street` - [`[String]!`](#string) | The street address for product returns. | +| `telephone` - [`String`](#string) | The telephone number for product returns. | + +#### Example + +```json +{ + "city": "abc123", + "contact_name": "abc123", + "country": Country, + "postcode": "abc123", + "region": Region, + "street": ["xyz789"], + "telephone": "xyz789" +} +``` + + + +### ReturnShippingCarrier + +Contains details about the carrier on a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the shipping carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | + +#### Example + +```json +{ + "label": "abc123", + "uid": "4" +} +``` + + + +### ReturnShippingTracking + +Contains shipping and tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | +| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | +| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | + +#### Example + +```json +{ + "carrier": ReturnShippingCarrier, + "status": ReturnShippingTrackingStatus, + "tracking_number": "xyz789", + "uid": "4" +} +``` + + + +### ReturnShippingTrackingStatus + +Contains the status of a shipment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `text` - [`String!`](#string) | Text that describes the status. | +| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | + +#### Example + +```json +{"text": "abc123", "type": "INFORMATION"} +``` + + + +### ReturnShippingTrackingStatusType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INFORMATION` | | +| `ERROR` | | + +#### Example + +```json +""INFORMATION"" +``` + + + +### ReturnStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `PARTIALLY_AUTHORIZED` | | +| `RECEIVED` | | +| `PARTIALLY_RECEIVED` | | +| `APPROVED` | | +| `PARTIALLY_APPROVED` | | +| `REJECTED` | | +| `PARTIALLY_REJECTED` | | +| `DENIED` | | +| `PROCESSED_AND_CLOSED` | | +| `CLOSED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### Returns + +Contains a list of customer return requests. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Return]`](#return) | A list of return requests. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The total number of return requests. | + +#### Example + +```json +{ + "items": [Return], + "page_info": SearchResultPageInfo, + "total_count": 987 +} +``` + + + +### RevokeCustomerTokenOutput + +Contains the result of a request to revoke a customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | + +#### Example + +```json +{"result": false} +``` + + + +### RewardPoints + +Contains details about a customer's reward points. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | +| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | +| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "balance_history": [RewardPointsBalanceHistoryItem], + "exchange_rates": RewardPointsExchangeRates, + "subscription_status": RewardPointsSubscriptionStatus +} +``` + + + +### RewardPointsAmount + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `money` - [`Money!`](#money) | The reward points amount in store currency. | +| `points` - [`Float!`](#float) | The reward points amount in points. | + +#### Example + +```json +{"money": Money, "points": 123.45} +``` + + + +### RewardPointsBalanceHistoryItem + +Contain details about the reward points transaction. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | +| `change_reason` - [`String!`](#string) | The reason the balance changed. | +| `date` - [`String!`](#string) | The date of the transaction. | +| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "change_reason": "abc123", + "date": "xyz789", + "points_change": 987.65 +} +``` + + + +### RewardPointsExchangeRates + +Lists the reward points exchange rates. The values depend on the customer group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | +| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | + +#### Example + +```json +{ + "earning": RewardPointsRate, + "redemption": RewardPointsRate +} +``` + + + +### RewardPointsRate + +Contains details about customer's reward points rate. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency_amount` - [`Float!`](#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!`](#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 + +```json +{"currency_amount": 123.45, "points": 987.65} +``` + + + +### RewardPointsSubscriptionStatus + +Indicates whether the customer subscribes to reward points emails. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | +| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | + +#### Example + +```json +{ + "balance_updates": "SUBSCRIBED", + "points_expiration_notifications": "SUBSCRIBED" +} +``` + + + +### RewardPointsSubscriptionStatusesEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUBSCRIBED` | | +| `NOT_SUBSCRIBED` | | + +#### Example + +```json +""SUBSCRIBED"" +``` + + + +### RoutableInterface + +Routable entities serve as the model for a rendered page. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Possible Types + +| RoutableInterface Types | +|----------------| +| [`CmsPage`](#cmspage) | +| [`CategoryTree`](#categorytree) | +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`ConfigurableProduct`](#configurableproduct) | + +#### Example + +```json +{ + "redirect_code": 987, + "relative_url": "abc123", + "type": "CMS_PAGE" +} +``` + + + +### SalesCommentItem + +Contains details about a comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The text of the message. | +| `timestamp` - [`String!`](#string) | The timestamp of the comment. | + +#### Example + +```json +{ + "message": "xyz789", + "timestamp": "abc123" +} +``` + + + +### ScopeTypeEnum + +This enumeration defines the scope type for customer orders. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `GLOBAL` | | +| `WEBSITE` | | +| `STORE` | | + +#### Example + +```json +""GLOBAL"" +``` + + + +### SearchResultPageInfo + +Provides navigation for the query response. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `current_page` - [`Int`](#int) | The specific page to return. | +| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](#int) | The total number of pages in the response. | + +#### Example + +```json +{"current_page": 987, "page_size": 123, "total_pages": 987} +``` + + + +### SearchSuggestion + +A string that contains search suggestion + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `search` - [`String!`](#string) | The search suggestion of existing product. | + +#### Example + +```json +{"search": "abc123"} +``` + + + +### SelectedBundleOption + +Contains details about a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `label` - [`String!`](#string) | The display name of the selected bundle product option. | +| `type` - [`String!`](#string) | The type of selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | +| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | + +#### Example + +```json +{ + "id": 987, + "label": "xyz789", + "type": "abc123", + "uid": "4", + "values": [SelectedBundleOptionValue] +} +``` + + + +### SelectedBundleOptionValue + +Contains details about a value for a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`Int!`](#int) | Use `uid` instead | +| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | +| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | + +#### Example + +```json +{ + "id": 987, + "label": "abc123", + "price": 123.45, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### SelectedConfigurableOption + +Contains details about a selected configurable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `option_label` - [`String!`](#string) | The display text for the option. | +| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | + +#### Example + +```json +{ + "configurable_product_option_uid": "4", + "configurable_product_option_value_uid": "4", + "id": 123, + "option_label": "abc123", + "value_id": 987, + "value_label": "abc123" +} +``` + + + +### SelectedCustomAttributeInput + +Contains details about an attribute the buyer selected. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | +| `value` - [`ID!`](#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | + +#### Example + +```json +{"attribute_code": "abc123", "value": 4} +``` + + + +### SelectedCustomizableOption + +Identifies a customized product that has been placed in a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | +| `label` - [`String!`](#string) | The display name of the selected customizable option. | +| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | +| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | +| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | + +#### Example + +```json +{ + "customizable_option_uid": 4, + "id": 987, + "is_required": true, + "label": "xyz789", + "sort_order": 123, + "type": "abc123", + "values": [SelectedCustomizableOptionValue] +} +``` + + + +### SelectedCustomizableOptionValue + +Identifies the value of the selected customized option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `label` - [`String!`](#string) | The display name of the selected value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `value` - [`String!`](#string) | The text identifying the selected value. | + +#### Example + +```json +{ + "customizable_option_value_uid": "4", + "id": 123, + "label": "xyz789", + "price": CartItemSelectedOptionValuePrice, + "value": "abc123" +} +``` + + + +### SelectedPaymentMethod + +Describes the payment method the shopper selected. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "purchase_order_number": "abc123", + "title": "abc123" +} +``` + + + +### SelectedShippingMethod + +Contains details about the selected shipping method and carrier. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | +| `method_title` - [`String!`](#string) | The label for the method code. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "base_amount": Money, + "carrier_code": "xyz789", + "carrier_title": "xyz789", + "method_code": "xyz789", + "method_title": "xyz789", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### SendEmailToFriendInput + +Defines the referenced product and the email sender and recipients. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "product_id": 987, + "recipients": [SendEmailToFriendRecipientInput], + "sender": SendEmailToFriendSenderInput +} +``` + + + +### SendEmailToFriendOutput + +Contains information about the sender and recipients. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "recipients": [SendEmailToFriendRecipient], + "sender": SendEmailToFriendSender +} +``` + + + +### SendEmailToFriendRecipient + +An output object that contains information about the recipient. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "abc123" +} +``` + + + +### SendEmailToFriendRecipientInput + +Contains details about a recipient. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | + +#### Example + +```json +{ + "email": "abc123", + "name": "abc123" +} +``` + + + +### SendEmailToFriendSender + +An output object that contains information about the sender. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "xyz789", + "message": "xyz789", + "name": "abc123" +} +``` + + + +### SendEmailToFriendSenderInput + +Contains details about the sender. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "xyz789", + "message": "xyz789", + "name": "abc123" +} +``` + + + +### SendFriendConfiguration + +Contains details about the configuration of the Email to a Friend feature. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | + +#### Example + +```json +{"enabled_for_customers": false, "enabled_for_guests": false} +``` + + + +### SendNegotiableQuoteForReviewInput + +Specifies which negotiable quote to send for review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} +``` + + + +### SendNegotiableQuoteForReviewOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetBillingAddressOnCartInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{ + "billing_address": BillingAddressInput, + "cart_id": "abc123" +} +``` + + + +### SetBillingAddressOnCartOutput + +Contains details about the cart after setting the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGiftOptionsOnCartInput + +Defines the gift options applied to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_message": GiftMessageInput, + "gift_receipt_included": false, + "gift_wrapping_id": "4", + "printed_card_included": true +} +``` + + + +### SetGiftOptionsOnCartOutput + +Contains the cart after gift options have been applied. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The modified cart object. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGuestEmailOnCartInput + +Defines the guest email and cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `email` - [`String!`](#string) | The email address of the guest. | + +#### Example + +```json +{ + "cart_id": "abc123", + "email": "abc123" +} +``` + + + +### SetGuestEmailOnCartOutput + +Contains details about the cart after setting the email of a guest. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetNegotiableQuoteBillingAddressInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "billing_address": NegotiableQuoteBillingAddressInput, + "quote_uid": "4" +} +``` + + + +### SetNegotiableQuoteBillingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuotePaymentMethodInput + +Defines the payment method of the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "payment_method": NegotiableQuotePaymentMethodInput, + "quote_uid": 4 +} +``` + + + +### SetNegotiableQuotePaymentMethodOutput + +Contains details about the negotiable quote after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingAddressInput + +Defines the shipping address to assign to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | + +#### Example + +```json +{ + "customer_address_id": "4", + "quote_uid": "4", + "shipping_addresses": [ + NegotiableQuoteShippingAddressInput + ] +} +``` + + + +### SetNegotiableQuoteShippingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingMethodsInput + +Defines the shipping method to apply to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | + +#### Example + +```json +{ + "quote_uid": "4", + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetNegotiableQuoteShippingMethodsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetPaymentMethodAndPlaceOrderInput + +Applies a payment method to the quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartInput + +Applies a payment method to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartOutput + +Contains details about the cart after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingAddressesOnCartInput + +Specifies an array of addresses to use for shipping. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "shipping_addresses": [ShippingAddressInput] +} +``` + + + +### SetShippingAddressesOnCartOutput + +Contains details about the cart after setting the shipping addresses. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingMethodsOnCartInput + +Applies one or shipping methods to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetShippingMethodsOnCartOutput + +Contains details about the cart after setting the shipping methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ShareGiftRegistryInviteeInput + +Defines a gift registry invitee. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the gift registry invitee. | +| `name` - [`String!`](#string) | The name of the gift registry invitee. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "xyz789" +} +``` + + + +### ShareGiftRegistryOutput + +Contains the results of a request to share a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | + +#### Example + +```json +{"is_shared": true} +``` + + + +### ShareGiftRegistrySenderInput + +Defines the sender of an invitation to view a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `message` - [`String!`](#string) | A brief message from the sender. | +| `name` - [`String!`](#string) | The sender of the gift registry invitation. | + +#### Example + +```json +{ + "message": "xyz789", + "name": "xyz789" +} +``` + + + +### ShipBundleItemsEnum + +Defines whether bundle items must be shipped together. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TOGETHER` | | +| `SEPARATELY` | | + +#### Example + +```json +""TOGETHER"" +``` + + + +### ShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 123.45 +} +``` + + + +### ShipmentItemInterface + +Order shipment item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Possible Types + +| ShipmentItemInterface Types | +|----------------| +| [`BundleShipmentItem`](#bundleshipmentitem) | +| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`ShipmentItem`](#shipmentitem) | + +#### Example + +```json +{ + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### ShipmentTracking + +Contains order shipment tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | +| `number` - [`String`](#string) | The tracking number of the order shipment. | +| `title` - [`String!`](#string) | The shipment tracking title. | + +#### Example + +```json +{ + "carrier": "xyz789", + "number": "xyz789", + "title": "abc123" +} +``` + + + +### ShippingAddressInput + +Defines a single shipping address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 123, + "customer_notes": "abc123", + "pickup_location_code": "abc123" +} +``` + + + +### ShippingCartAddress + +Contains shipping addresses and methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "available_shipping_methods": [AvailableShippingMethod], + "cart_items": [CartItemQuantity], + "cart_items_v2": [CartItemInterface], + "city": "xyz789", + "company": "abc123", + "country": CartAddressCountry, + "customer_notes": "abc123", + "firstname": "xyz789", + "items_weight": 123.45, + "lastname": "abc123", + "pickup_location_code": "abc123", + "postcode": "xyz789", + "region": CartAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["xyz789"], + "telephone": "xyz789", + "uid": "xyz789", + "vat_id": "abc123" +} +``` + + + +### ShippingDiscount + +Defines an individual shipping discount. This discount can be applied to shipping. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | + +#### Example + +```json +{"amount": Money} +``` + + + +### ShippingHandling + +Contains details about shipping and handling costs. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | +| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](#money) | The total amount for shipping. | + +#### Example + +```json +{ + "amount_excluding_tax": Money, + "amount_including_tax": Money, + "discounts": [ShippingDiscount], + "taxes": [TaxItem], + "total_amount": Money +} +``` + + + +### ShippingMethodInput + +Defines the shipping carrier and method. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | +| `method_code` - [`String!`](#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 + +```json +{ + "carrier_code": "xyz789", + "method_code": "xyz789" +} +``` + + + +### SimpleCartItem + +An implementation for simple product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "available_gift_wrapping": [GiftWrapping], + "customizable_options": [SelectedCustomizableOption], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "abc123", + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### SimpleProduct + +Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "abc123", + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "category_gear": "xyz789", + "climate": "abc123", + "collar": "abc123", + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "eco_collection": 987, + "erin_recommends": 123, + "features_bags": "abc123", + "format": 123, + "gender": "xyz789", + "gift_message_available": "abc123", + "id": 123, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 123, + "material": "xyz789", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "abc123", + "name": "abc123", + "new": 123, + "new_from_date": "xyz789", + "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": 123, + "rating_summary": 987.65, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "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": "abc123", + "style_bottom": "abc123", + "style_general": "xyz789", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "tier_price": 987.65, + "tier_prices": [ProductTierPrices], + "type": "CMS_PAGE", + "type_id": "abc123", + "uid": 4, + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### SimpleProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### SimpleRequisitionListItem + +Contains details about simple products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### SimpleWishlistItem + +Contains a simple product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### SortEnum + +Indicates whether to return results in ascending or descending order. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ASC` | | +| `DESC` | | + +#### Example + +```json +""ASC"" +``` + + + +### SortField + +Defines a possible sort field. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label of the sort field. | +| `value` - [`String`](#string) | The attribute code of the sort field. | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### SortFields + +Contains a default value for sort fields and all available sort fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `default` - [`String`](#string) | The default sort field value. | +| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | + +#### Example + +```json +{ + "default": "abc123", + "options": [SortField] +} +``` + + + +### StoreConfig + +Contains information about a store's configuration. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `` tag. | +| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | +| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | +| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | +| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | +| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `base_currency_code` - [`String`](#string) | The base currency code. | +| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | +| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | +| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | +| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | +| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | +| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | +| `cart_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | +| `catalog_default_sort_by` - [`String`](#string) | The default sort order of the search results list. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | +| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | +| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | +| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | +| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | +| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | +| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | +| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | +| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | +| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | +| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | +| `default_description` - [`String`](#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`](#string) | The default display currency code. | +| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | +| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | +| `demonotice` - [`Int`](#int) | Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes). | +| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | +| `front` - [`String`](#string) | The landing page that is associated with the base URL. | +| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | +| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | +| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `` tag. | +| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | +| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | +| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | +| `list_mode` - [`String`](#string) | The format of the search results list. | +| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | +| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | +| `locale` - [`String`](#string) | The store locale. | +| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | +| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | +| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | +| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | +| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | +| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | +| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | +| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | +| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | +| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | +| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | +| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | +| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | +| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | +| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | +| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | +| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | +| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | +| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | +| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | +| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | +| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | +| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | +| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `store_group_name` - [`String`](#string) | The label assigned to the store group. | +| `store_name` - [`String`](#string) | The label assigned to the store view. | +| `store_sort_order` - [`Int`](#int) | The store view sort order. | +| `timezone` - [`String`](#string) | The time zone of the store. | +| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | +| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | +| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | +| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](#id) | The unique ID for the website. | +| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `website_name` - [`String`](#string) | The label assigned to the website. | +| `weight_unit` - [`String`](#string) | The unit of weight. | +| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | +| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | +| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | + +#### Example + +```json +{ + "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": "xyz789", + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": true, + "base_currency_code": "xyz789", + "base_link_url": "abc123", + "base_media_url": "xyz789", + "base_static_url": "xyz789", + "base_url": "xyz789", + "braintree_cc_vault_active": "xyz789", + "cart_gift_wrapping": "abc123", + "cart_printed_card": "xyz789", + "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": "xyz789", + "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": "abc123", + "check_money_order_sort_order": 987, + "check_money_order_title": "abc123", + "cms_home_page": "xyz789", + "cms_no_cookies": "abc123", + "cms_no_route": "abc123", + "code": "abc123", + "configurable_thumbnail_source": "xyz789", + "copyright": "xyz789", + "default_description": "xyz789", + "default_display_currency_code": "xyz789", + "default_keywords": "xyz789", + "default_title": "xyz789", + "demonotice": 987, + "enable_multiple_wishlists": "abc123", + "front": "xyz789", + "grid_per_page": 987, + "grid_per_page_values": "abc123", + "head_includes": "xyz789", + "head_shortcut_icon": "xyz789", + "header_logo_src": "xyz789", + "id": 987, + "is_default_store": false, + "is_default_store_group": false, + "is_negotiable_quote_active": true, + "is_requisition_list_active": "abc123", + "list_mode": "xyz789", + "list_per_page": 123, + "list_per_page_values": "abc123", + "locale": "abc123", + "logo_alt": "xyz789", + "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_publish_history": "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_newsletter": "abc123", + "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": "xyz789", + "maximum_number_of_wishlists": "xyz789", + "minimum_password_length": "xyz789", + "no_route": "abc123", + "payment_payflowpro_cc_vault_active": "xyz789", + "printed_card_price": "abc123", + "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", + "product_reviews_enabled": "xyz789", + "product_url_suffix": "abc123", + "required_character_classes_number": "xyz789", + "returns_enabled": "abc123", + "root_category_id": 987, + "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": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "abc123", + "send_friend": SendFriendConfiguration, + "show_cms_breadcrumbs": 987, + "store_code": "4", + "store_group_code": 4, + "store_group_name": "abc123", + "store_name": "abc123", + "store_sort_order": 123, + "timezone": "xyz789", + "title_prefix": "xyz789", + "title_separator": "xyz789", + "title_suffix": "xyz789", + "use_store_in_url": true, + "website_code": "4", + "website_id": 987, + "website_name": "abc123", + "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": "xyz789", + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "abc123" +} +``` + + + +### StorefrontProperties + +Indicates where an attribute can be displayed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | + +#### Example + +```json +{ + "position": 987, + "use_in_layered_navigation": "NO", + "use_in_product_listing": false, + "use_in_search_results_layered_navigation": true, + "visible_on_catalog_pages": false +} +``` + + + +### String + +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 + +```json +"xyz789" +``` + + + +### SubscribeEmailToNewsletterOutput + +Contains the result of the `subscribeEmailToNewsletter` operation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | + +#### Example + +```json +{"status": "NOT_ACTIVE"} +``` + + + +### SubscriptionStatusesEnum + +Indicates the status of the request. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_ACTIVE` | | +| `SUBSCRIBED` | | +| `UNSUBSCRIBED` | | +| `UNCONFIRMED` | | + +#### Example + +```json +""NOT_ACTIVE"" +``` + + + +### SwatchData + +Describes the swatch type and a value. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | +| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | + +#### Example + +```json +{ + "type": "abc123", + "value": "abc123" +} +``` + + + +### SwatchDataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Possible Types + +| SwatchDataInterface Types | +|----------------| +| [`ImageSwatchData`](#imageswatchdata) | +| [`TextSwatchData`](#textswatchdata) | +| [`ColorSwatchData`](#colorswatchdata) | + +#### Example + +```json +{"value": "abc123"} +``` + + + +### SwatchLayerFilterItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Example + +```json +{ + "items_count": 123, + "label": "xyz789", + "swatch_data": SwatchData, + "value_string": "abc123" +} +``` + + + +### SwatchLayerFilterItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | + +#### Possible Types + +| SwatchLayerFilterItemInterface Types | +|----------------| +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | + +#### Example + +```json +{"swatch_data": SwatchData} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-t-z.md new file mode 100644 index 000000000..e201445db --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-t-z.md @@ -0,0 +1,1369 @@ +## Types + +### TaxItem + +Contains tax item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | +| `title` - [`String!`](#string) | A title that describes the tax. | + +#### Example + +```json +{ + "amount": Money, + "rate": 987.65, + "title": "xyz789" +} +``` + + + +### TextSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{"value": "abc123"} +``` + + + +### TierPrice + +Defines a price based on the quantity purchased. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](#money) | The price of the product at this tier. | +| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | + +#### Example + +```json +{ + "discount": ProductDiscount, + "final_price": Money, + "quantity": 123.45 +} +``` + + + +### UpdateCartItemsInput + +Modifies the specified items in the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [CartItemUpdateInput] +} +``` + + + +### UpdateCartItemsOutput + +Contains details about the cart after updating items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after updating products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### UpdateCompanyOutput + +Contains the response to the request to update the company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyRoleOutput + +Contains the response to the request to update the company role. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | + +#### Example + +```json +{"role": CompanyRole} +``` + + + +### UpdateCompanyStructureOutput + +Contains the response to the request to update the company structure. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyTeamOutput + +Contains the response to the request to update a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | + +#### Example + +```json +{"team": CompanyTeam} +``` + + + +### UpdateCompanyUserOutput + +Contains the response to the request to update the company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user` - [`Customer!`](#customer) | The updated company user instance. | + +#### Example + +```json +{"user": Customer} +``` + + + +### UpdateGiftRegistryInput + +Defines updates to a `GiftRegistry` object. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](#string) | The updated name of the event. | +| `message` - [`String`](#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "xyz789", + "message": "xyz789", + "privacy_settings": "PRIVATE", + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" +} +``` + + + +### UpdateGiftRegistryItemInput + +Defines updates to an item in a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](#string) | The updated description of the item. | +| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | + +#### Example + +```json +{ + "gift_registry_item_uid": "4", + "note": "xyz789", + "quantity": 123.45 +} +``` + + + +### UpdateGiftRegistryItemsOutput + +Contains the results of a request to update gift registry items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryOutput + +Contains the results of a request to update a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryRegistrantInput + +Defines updates to an existing registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | +| `firstname` - [`String`](#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](#string) | The updated last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "xyz789", + "gift_registry_registrant_uid": 4, + "lastname": "xyz789" +} +``` + + + +### UpdateGiftRegistryRegistrantsOutput + +Contains the results a request to update registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateNegotiableQuoteItemsQuantityOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### UpdateNegotiableQuoteQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteItemQuantityInput], + "quote_uid": 4 +} +``` + + + +### UpdateProductsInWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### UpdatePurchaseOrderApprovalRuleInput + +Defines the changes to be made to an approval rule. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](#string) | The updated approval rule description. | +| `name` - [`String`](#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | + +#### Example + +```json +{ + "applies_to": [4], + "approvers": ["4"], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "xyz789", + "name": "xyz789", + "status": "ENABLED", + "uid": "4" +} +``` + + + +### UpdateRequisitionListInput + +An input object that defines which requistion list characteristics to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | The updated description of the requisition list. | +| `name` - [`String!`](#string) | The new name of the requisition list. | + +#### Example + +```json +{ + "description": "abc123", + "name": "abc123" +} +``` + + + +### UpdateRequisitionListItemsInput + +Defines which items in a requisition list to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "item_id": "4", + "quantity": 987.65, + "selected_options": ["abc123"] +} +``` + + + +### UpdateRequisitionListItemsOutput + +Output of the request to update items in the specified requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateRequisitionListOutput + +Output of the request to rename the requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateWishlistOutput + +Contains the name and visibility of an updated wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](#string) | The wish list name. | +| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "name": "abc123", + "uid": 4, + "visibility": "PUBLIC" +} +``` + + + +### UrlRewrite + +Contains URL rewrite details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](#string) | The request URL. | + +#### Example + +```json +{ + "parameters": [HttpQueryParameter], + "url": "abc123" +} +``` + + + +### UrlRewriteEntityTypeEnum + +This enumeration defines the entity type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CMS_PAGE` | | +| `PRODUCT` | | +| `CATEGORY` | | + +#### Example + +```json +""CMS_PAGE"" +``` + + + +### UseInLayeredNavigationOptions + +Defines whether the attribute is filterable in layered navigation. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NO` | | +| `FILTERABLE_WITH_RESULTS` | | +| `FILTERABLE_NO_RESULT` | | + +#### Example + +```json +""NO"" +``` + + + +### ValidatePurchaseOrderError + +Contains details about a failed validation attempt. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | + +#### Example + +```json +{"message": "xyz789", "type": "NOT_FOUND"} +``` + + + +### ValidatePurchaseOrderErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | + +#### Example + +```json +""NOT_FOUND"" +``` + + + +### ValidatePurchaseOrdersInput + +Defines the purchase orders to be validated. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | + +#### Example + +```json +{"purchase_order_uids": ["4"]} +``` + + + +### ValidatePurchaseOrdersOutput + +Contains the results of validation attempts. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | + +#### Example + +```json +{ + "errors": [ValidatePurchaseOrderError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### VaultTokenInput + +Contains required input for payment methods with Vault support. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `public_hash` - [`String!`](#string) | The public hash of the payment token. | + +#### Example + +```json +{"public_hash": "xyz789"} +``` + + + +### VirtualCartItem + +An implementation for virtual product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "errors": [CartItemError], + "id": "abc123", + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### VirtualProduct + +Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "activity": "xyz789", + "attribute_set_id": 987, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "xyz789", + "collar": "abc123", + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "description": ComplexTextValue, + "eco_collection": 123, + "erin_recommends": 123, + "features_bags": "abc123", + "format": 987, + "gender": "xyz789", + "gift_message_available": "abc123", + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 123, + "material": "abc123", + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "name": "abc123", + "new": 123, + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "pattern": "abc123", + "performance_fabric": 123, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 123, + "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": "abc123", + "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": "abc123", + "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": "abc123", + "websites": [Website] +} +``` + + + +### VirtualProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### VirtualRequisitionListItem + +Contains details about virtual products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### VirtualWishlistItem + +Contains a virtual product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### Website + +Deprecated. It should not be used on the storefront. Contains information about a website. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | +| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "code": "abc123", + "default_group_id": "abc123", + "id": 123, + "is_default": false, + "name": "xyz789", + "sort_order": 123 +} +``` + + + +### WishListUserInputError + +An error encountered while performing operations with WishList. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123" +} +``` + + + +### WishListUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### Wishlist + +Contains a customer wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. | +| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | +| `name` - [`String`](#string) | The name of the wish list. | +| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "id": 4, + "items": [WishlistItem], + "items_count": 987, + "items_v2": WishlistItems, + "name": "xyz789", + "sharing_code": "abc123", + "updated_at": "xyz789", + "visibility": "PUBLIC" +} +``` + + + +### WishlistCartUserInputError + +Contains details about errors encountered when a customer added wish list items to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | +| `message` - [`String!`](#string) | A localized error message. | +| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789", + "wishlistId": "4", + "wishlistItemId": "4" +} +``` + + + +### WishlistCartUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### WishlistItem + +Contains details about a wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](#string) | The customer's comment about this item. | +| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](#float) | The quantity of this wish list item | + +#### Example + +```json +{ + "added_at": "abc123", + "description": "xyz789", + "id": 987, + "product": ProductInterface, + "qty": 987.65 +} +``` + + + +### WishlistItemCopyInput + +Specifies the IDs of items to copy and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | + +#### Example + +```json +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} +``` + + + +### WishlistItemInput + +Defines the items to add to a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 123.45, + "selected_options": ["4"], + "sku": "abc123" +} +``` + + + +### WishlistItemInterface + +The interface for wish list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Possible Types + +| WishlistItemInterface Types | +|----------------| +| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`VirtualWishlistItem`](#virtualwishlistitem) | +| [`DownloadableWishlistItem`](#downloadablewishlistitem) | +| [`BundleWishlistItem`](#bundlewishlistitem) | +| [`GiftCardWishlistItem`](#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | +| [`ConfigurableWishlistItem`](#configurablewishlistitem) | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### WishlistItemMoveInput + +Specifies the IDs of the items to move and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | + +#### Example + +```json +{ + "quantity": 123.45, + "wishlist_item_id": "4" +} +``` + + + +### WishlistItemUpdateInput + +Defines updates to items in a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | + +#### Example + +```json +{ + "description": "xyz789", + "entered_options": [EnteredOptionInput], + "quantity": 123.45, + "selected_options": [4], + "wishlist_item_id": 4 +} +``` + + + +### WishlistItems + +Contains an array of items in a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | + +#### Example + +```json +{ + "items": [WishlistItemInterface], + "page_info": SearchResultPageInfo +} +``` + + + +### WishlistOutput + +Deprecated: Use the `Wishlist` type instead. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | +| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | + +#### Example + +```json +{ + "items": [WishlistItem], + "items_count": 987, + "name": "abc123", + "sharing_code": "xyz789", + "updated_at": "xyz789" +} +``` + + + +### WishlistVisibilityEnum + +Defines the wish list visibility types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PUBLIC` | | +| `PRIVATE` | | + +#### Example + +```json +""PUBLIC"" +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-mutations.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-mutations.md index 0d15a32de..58a10e875 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-mutations.md @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": false}}} +{"data": {"acceptCompanyInvitation": {"success": true}}} ``` @@ -107,12 +107,12 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ @@ -120,7 +120,7 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu ], "status": "abc123", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -416,7 +416,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -521,7 +521,10 @@ mutation addProductsToWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} +{ + "wishlistId": "4", + "wishlistItems": [WishlistItemInput] +} ``` ##### Response @@ -676,7 +679,7 @@ mutation addRequisitionListItemsToCart( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItemUids": ["4"] } ``` @@ -909,10 +912,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemIds": ["4"] -} +{"wishlistId": 4, "wishlistItemIds": ["4"]} ``` ##### Response @@ -924,7 +924,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -1082,7 +1082,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -1308,7 +1308,7 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ##### Variables ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` ##### Response @@ -1329,14 +1329,14 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "billing_address": BillingCartAddress, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "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, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 987.65 @@ -1417,18 +1417,18 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "abc123", + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", + "status": "xyz789", + "template_id": 4, "total_quantity": 987.65 } } @@ -1476,7 +1476,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "xyz789", + "error": "abc123", "order": CustomerOrder } } @@ -1545,8 +1545,8 @@ Change the password for the logged-in customer. | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](#string) | The customer's original password. | +| `newPassword` - [`String!`](#string) | The customer's updated password. | #### Example @@ -1661,7 +1661,7 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "xyz789", + "currentPassword": "abc123", "newPassword": "xyz789" } ``` @@ -1673,26 +1673,26 @@ mutation changeCustomerPassword( "data": { "changeCustomerPassword": { "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": true, + "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", "default_billing": "xyz789", - "default_shipping": "xyz789", + "default_shipping": "abc123", "dob": "abc123", - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", - "gender": 987, + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 987, - "id": 123, - "is_subscribed": false, - "job_title": "xyz789", - "lastname": "xyz789", + "group_id": 123, + "id": 987, + "is_subscribed": true, + "job_title": "abc123", + "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, "prefix": "abc123", @@ -1711,10 +1711,10 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "xyz789", - "taxvat": "abc123", + "suffix": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1813,7 +1813,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": false} + "clearCustomerCart": {"cart": Cart, "status": true} } } ``` @@ -2067,7 +2067,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } @@ -2110,7 +2110,7 @@ mutation createBraintreeClientToken { ```json { "data": { - "createBraintreeClientToken": "xyz789" + "createBraintreeClientToken": "abc123" } } ``` @@ -2138,7 +2138,7 @@ mutation createBraintreePayPalClientToken { ```json { "data": { - "createBraintreePayPalClientToken": "xyz789" + "createBraintreePayPalClientToken": "abc123" } } ``` @@ -2178,7 +2178,7 @@ mutation createBraintreePayPalVaultClientToken($input: BraintreeVaultInput) { ```json { "data": { - "createBraintreePayPalVaultClientToken": "abc123" + "createBraintreePayPalVaultClientToken": "xyz789" } } ``` @@ -2512,22 +2512,22 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": false, - "default_shipping": false, + "default_billing": true, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "abc123", - "id": 123, - "lastname": "abc123", - "middlename": "abc123", + "firstname": "xyz789", + "id": 987, + "lastname": "xyz789", + "middlename": "xyz789", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" + "region_id": 987, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "xyz789" } } } @@ -2610,7 +2610,7 @@ mutation createEmptyCart($input: createEmptyCartInput) { ##### Response ```json -{"data": {"createEmptyCart": "xyz789"}} +{"data": {"createEmptyCart": "abc123"}} ``` @@ -2739,9 +2739,9 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "xyz789", - "result": 123, - "result_code": 987, + "response_message": "abc123", + "result": 987, + "result_code": 123, "secure_token": "xyz789", "secure_token_id": "abc123" } @@ -2791,11 +2791,11 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, + "amount": 987.65, "currency_code": "abc123", - "id": "xyz789", + "id": "abc123", "mp_order_id": "xyz789", - "status": "abc123" + "status": "xyz789" } } } @@ -2843,7 +2843,7 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { "data": { "createPaypalExpressToken": { "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" + "token": "abc123" } } } @@ -2949,13 +2949,13 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "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": "abc123" + "uid": 4, + "updated_at": "xyz789" } } } @@ -3076,13 +3076,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": true}}} +{"data": {"deleteCompanyRole": {"success": false}}} ``` @@ -3114,7 +3114,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3156,13 +3156,13 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyUser": {"success": true}}} +{"data": {"deleteCompanyUser": {"success": false}}} ``` @@ -3194,7 +3194,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3232,7 +3232,7 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -3298,7 +3298,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Response ```json -{"data": {"deleteCustomerAddress": false}} +{"data": {"deleteCustomerAddress": true}} ``` @@ -3532,7 +3532,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { "data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": true + "status": false } } } @@ -3578,7 +3578,7 @@ mutation deleteRequisitionListItems( ```json { "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListItemUids": ["4"] } ``` @@ -3626,7 +3626,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -3746,10 +3746,10 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "available": true, "base_amount": Money, "carrier_code": "abc123", - "carrier_title": "abc123", - "error_message": "xyz789", - "method_code": "xyz789", - "method_title": "abc123", + "carrier_title": "xyz789", + "error_message": "abc123", + "method_code": "abc123", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -3810,8 +3810,8 @@ Generate a token for specified customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -3836,7 +3836,7 @@ mutation generateCustomerToken( ```json { "email": "abc123", - "password": "abc123" + "password": "xyz789" } ``` @@ -3890,7 +3890,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "abc123" + "customer_token": "xyz789" } } } @@ -3931,13 +3931,7 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom ##### Response ```json -{ - "data": { - "generateNegotiableQuoteFromTemplate": { - "negotiable_quote_uid": "4" - } - } -} +{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}} ``` @@ -3992,7 +3986,7 @@ Transfer the contents of a guest cart into the cart of a logged-in customer. | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | +| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | | `destination_cart_id` - [`String`](#string) | The cart ID after the guest logs in. | #### Example @@ -4088,19 +4082,19 @@ mutation mergeCarts( AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -4148,7 +4142,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": 4, "giftRegistryUid": 4} +{"cartUid": "4", "giftRegistryUid": 4} ``` ##### Response @@ -4211,7 +4205,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": "4", + "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4323,7 +4317,7 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", + "sourceWishlistUid": 4, "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } @@ -4412,10 +4406,10 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "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, @@ -4485,7 +4479,7 @@ Convert the quote into an order. | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4660,8 +4654,8 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } } } @@ -5145,16 +5139,16 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "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, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", - "total_quantity": 987.65 + "template_id": 4, + "total_quantity": 123.45 } } } @@ -5206,7 +5200,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": "4" } @@ -5255,7 +5249,10 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": ["4"]} +{ + "wishlistId": "4", + "wishlistItemsIds": ["4"] +} ``` ##### Response @@ -5598,7 +5595,7 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "requestNegotiableQuoteTemplateFromQuote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, "is_virtual": false, @@ -5611,9 +5608,9 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", - "total_quantity": 987.65 + "status": "abc123", + "template_id": 4, + "total_quantity": 123.45 } } } @@ -5631,7 +5628,7 @@ Request an email with a reset password token for the registered customer identif | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](#string) | The customer's email address. | #### Example @@ -5646,13 +5643,13 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"requestPasswordResetEmail": true}} +{"data": {"requestPasswordResetEmail": false}} ``` @@ -5717,9 +5714,9 @@ Reset a customer's password using the reset password token that the customer rec | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](#string) | The customer's new password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](#string) | The customer's new password. | #### Example @@ -5752,7 +5749,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -6290,22 +6287,22 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -6480,8 +6477,8 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "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, @@ -6491,9 +6488,9 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -6592,7 +6589,7 @@ Send an email about the gift registry to a list of invitees. | Name | Description | |------|-------------| | `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | | `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -6702,19 +6699,19 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", + "template_id": 4, "total_quantity": 987.65 } } @@ -6733,7 +6730,7 @@ Subscribe the specified email to the store's newsletter. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | #### Example @@ -7141,7 +7138,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 987, "input": CustomerAddressInput} +{"id": 123, "input": CustomerAddressInput} ``` ##### Response @@ -7150,29 +7147,29 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country_code": "AF", - "country_id": "xyz789", + "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, + "customer_id": 987, "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "id": 987, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "xyz789" + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" } } } @@ -7190,8 +7187,8 @@ Change the email address for the logged-in customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -7217,7 +7214,7 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", + "email": "xyz789", "password": "xyz789" } ``` @@ -7417,7 +7414,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -7643,7 +7640,7 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "xyz789", + "created_by": "abc123", "description": "abc123", "name": "xyz789", "status": "ENABLED", @@ -7749,7 +7746,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -7810,8 +7807,8 @@ mutation updateWishlist( ```json { - "wishlistId": 4, - "name": "abc123", + "wishlistId": "4", + "name": "xyz789", "visibility": "PUBLIC" } ``` @@ -7822,8 +7819,8 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "abc123", - "uid": "4", + "name": "xyz789", + "uid": 4, "visibility": "PUBLIC" } } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-queries.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-queries.md index 4829758ad..bcc2c98ea 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-queries.md @@ -48,7 +48,7 @@ query attributesForm($formCode: String!) { ##### Variables ```json -{"formCode": "abc123"} +{"formCode": "xyz789"} ``` ##### Response @@ -384,223 +384,223 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "absolute_footer": "xyz789", - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", + "absolute_footer": "abc123", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "abc123", - "allow_order": "abc123", - "allow_printed_card": "abc123", + "allow_items": "xyz789", + "allow_order": "xyz789", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, "base_currency_code": "abc123", - "base_link_url": "abc123", + "base_link_url": "xyz789", "base_media_url": "xyz789", "base_static_url": "xyz789", - "base_url": "xyz789", - "braintree_3dsecure_allowspecific": false, - "braintree_3dsecure_always_request_3ds": false, + "base_url": "abc123", + "braintree_3dsecure_allowspecific": true, + "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "xyz789", - "braintree_3dsecure_threshold_amount": "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_merchant_name": "xyz789", "braintree_applepay_vault_active": false, "braintree_cc_vault_active": "xyz789", "braintree_cc_vault_cvv": true, "braintree_environment": "xyz789", "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "abc123", - "braintree_googlepay_merchant_id": "abc123", + "braintree_googlepay_merchant_id": "xyz789", "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": "abc123", - "braintree_merchant_account_id": "abc123", + "braintree_local_payment_redirect_on_fail": "xyz789", + "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": "abc123", + "braintree_paypal_button_location_cart_type_credit_label": "xyz789", + "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_text_color": "abc123", + "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": "xyz789", "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_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": "abc123", - "braintree_paypal_button_location_cart_type_paypal_shape": "abc123", + "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": "xyz789", - "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_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_logo": "abc123", + "braintree_paypal_button_location_checkout_type_messaging_logo_position": "abc123", "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": "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": false, + "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_show": true, "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_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": "xyz789", - "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", + "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_credit_show": true, "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": "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_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_paypal_color": "abc123", + "braintree_paypal_button_location_productpage_type_paylater_label": "abc123", + "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": "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_shape": "xyz789", "braintree_paypal_button_location_productpage_type_paypal_show": true, - "braintree_paypal_credit_uk_merchant_name": "xyz789", - "braintree_paypal_display_on_shopping_cart": false, - "braintree_paypal_merchant_country": "abc123", + "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_display_on_shopping_cart": true, + "braintree_paypal_merchant_country": "xyz789", "braintree_paypal_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": true, "braintree_paypal_send_cart_line_items": false, "braintree_paypal_vault_active": false, - "cart_expires_in_days": 987, + "cart_expires_in_days": 123, "cart_gift_wrapping": "xyz789", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "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": true, - "check_money_order_enabled": true, - "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": "xyz789", - "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 123, + "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_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": "abc123", + "check_money_order_send_check_to": "xyz789", + "check_money_order_sort_order": 987, "check_money_order_title": "abc123", - "cms_home_page": "abc123", + "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", - "cms_no_route": "xyz789", - "code": "xyz789", + "cms_no_route": "abc123", + "code": "abc123", "configurable_thumbnail_source": "xyz789", "contact_enabled": true, - "copyright": "abc123", + "copyright": "xyz789", "countries_with_required_region": "xyz789", - "create_account_confirmation": true, - "customer_access_token_lifetime": 123.45, + "create_account_confirmation": false, + "customer_access_token_lifetime": 987.65, "default_country": "xyz789", - "default_description": "xyz789", - "default_display_currency_code": "abc123", + "default_description": "abc123", + "default_display_currency_code": "xyz789", "default_keywords": "xyz789", - "default_title": "xyz789", + "default_title": "abc123", "demonotice": 123, "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", + "enable_multiple_wishlists": "xyz789", "front": "xyz789", "grid_per_page": 123, "grid_per_page_values": "abc123", - "head_includes": "abc123", + "head_includes": "xyz789", "head_shortcut_icon": "xyz789", "header_logo_src": "xyz789", "id": 123, - "is_default_store": true, - "is_default_store_group": true, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": false, + "is_default_store": false, + "is_default_store_group": false, + "is_guest_checkout_enabled": true, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "abc123", + "is_requisition_list_active": "xyz789", "list_mode": "xyz789", "list_per_page": 123, - "list_per_page_values": "abc123", + "list_per_page_values": "xyz789", "locale": "xyz789", "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": "abc123", - "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "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_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "xyz789", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 987, - "maximum_number_of_wishlists": "abc123", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "xyz789", "minicart_display": true, - "minicart_max_items": 123, + "minicart_max_items": 987, "minimum_password_length": "abc123", "newsletter_enabled": false, "no_route": "abc123", - "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": false, "order_cancellation_reasons": [ CancellationReason ], "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "xyz789", + "printed_card_price": "abc123", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "abc123", + "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", - "quickorder_active": false, - "required_character_classes_number": "xyz789", + "quickorder_active": true, + "required_character_classes_number": "abc123", "returns_enabled": "abc123", - "root_category_id": 987, - "root_category_uid": 4, + "root_category_id": 123, + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", + "sales_gift_wrapping": "abc123", "sales_printed_card": "xyz789", "secure_base_link_url": "abc123", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 123, + "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": 987, - "store_code": 4, - "store_group_code": 4, - "store_group_name": "xyz789", + "show_cms_breadcrumbs": 123, + "store_code": "4", + "store_group_code": "4", + "store_group_name": "abc123", "store_name": "abc123", - "store_sort_order": 123, + "store_sort_order": 987, "timezone": "xyz789", - "title_prefix": "xyz789", + "title_prefix": "abc123", "title_separator": "xyz789", "title_suffix": "xyz789", "use_store_in_url": true, "website_code": "4", "website_id": 123, - "website_name": "xyz789", - "weight_unit": "abc123", + "website_name": "abc123", + "weight_unit": "xyz789", "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "abc123", + "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" @@ -689,7 +689,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -708,16 +708,16 @@ query cart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], "total_quantity": 123.45 @@ -869,7 +869,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -878,42 +878,42 @@ query category($id: Int) { { "data": { "category": { - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], + "automatic_sorting": "xyz789", + "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": "abc123", + "custom_layout_update_file": "xyz789", "default_sort_by": "abc123", - "description": "xyz789", + "description": "abc123", "display_mode": "xyz789", - "filter_price_range": 123.45, - "id": 987, + "filter_price_range": 987.65, + "id": 123, "image": "abc123", - "include_in_menu": 123, + "include_in_menu": 987, "is_anchor": 987, - "landing_page": 987, - "level": 123, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", + "landing_page": 123, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", "path": "xyz789", - "path_in_store": "xyz789", - "position": 987, + "path_in_store": "abc123", + "position": 123, "product_count": 123, "products": CategoryProducts, "redirect_code": 987, "relative_url": "xyz789", "staged": false, "type": "CMS_PAGE", - "uid": "4", - "updated_at": "abc123", - "url_key": "xyz789", - "url_path": "abc123", + "uid": 4, + "updated_at": "xyz789", + "url_key": "abc123", + "url_path": "xyz789", "url_suffix": "xyz789" } } @@ -1024,40 +1024,40 @@ query categoryList( "automatic_sorting": "xyz789", "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "xyz789", "custom_layout_update_file": "abc123", "default_sort_by": "abc123", - "description": "xyz789", + "description": "abc123", "display_mode": "abc123", - "filter_price_range": 987.65, - "id": 123, + "filter_price_range": 123.45, + "id": 987, "image": "abc123", "include_in_menu": 123, "is_anchor": 987, - "landing_page": 987, - "level": 123, - "meta_description": "abc123", + "landing_page": 123, + "level": 987, + "meta_description": "xyz789", "meta_keywords": "xyz789", "meta_title": "abc123", - "name": "abc123", - "path": "xyz789", + "name": "xyz789", + "path": "abc123", "path_in_store": "xyz789", - "position": 987, + "position": 123, "product_count": 987, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", "staged": false, "type": "CMS_PAGE", "uid": "4", - "updated_at": "xyz789", + "updated_at": "abc123", "url_key": "abc123", - "url_path": "xyz789", - "url_suffix": "xyz789" + "url_path": "abc123", + "url_suffix": "abc123" } ] } @@ -1097,10 +1097,10 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 987, - "checkbox_text": "xyz789", - "content": "abc123", - "content_height": "abc123", + "agreement_id": 123, + "checkbox_text": "abc123", + "content": "xyz789", + "content_height": "xyz789", "is_html": true, "mode": "AUTO", "name": "abc123" @@ -1197,7 +1197,7 @@ query cmsPage( ##### Variables ```json -{"id": 987, "identifier": "abc123"} +{"id": 987, "identifier": "xyz789"} ``` ##### Response @@ -1206,18 +1206,18 @@ query cmsPage( { "data": { "cmsPage": { - "content": "xyz789", - "content_heading": "abc123", + "content": "abc123", + "content_heading": "xyz789", "identifier": "abc123", "meta_description": "abc123", "meta_keywords": "abc123", - "meta_title": "abc123", - "page_layout": "xyz789", - "redirect_code": 987, + "meta_title": "xyz789", + "page_layout": "abc123", + "redirect_code": 123, "relative_url": "abc123", - "title": "abc123", + "title": "xyz789", "type": "CMS_PAGE", - "url_key": "xyz789" + "url_key": "abc123" } } } @@ -1296,12 +1296,12 @@ query company { "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": "4", + "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "xyz789", - "name": "abc123", + "legal_name": "abc123", + "name": "xyz789", "payment_methods": ["abc123"], - "reseller_id": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1309,7 +1309,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -1361,7 +1361,7 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": "4" } @@ -1404,9 +1404,9 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "abc123", - "id": "xyz789", + "full_name_english": "abc123", + "full_name_locale": "xyz789", + "id": "abc123", "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "abc123" } @@ -1461,10 +1461,10 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "abc123", + "id": "xyz789", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" } } @@ -1509,9 +1509,9 @@ query currency { "available_currency_codes": [ "xyz789" ], - "base_currency_code": "xyz789", + "base_currency_code": "abc123", "base_currency_symbol": "xyz789", - "default_display_currecy_code": "xyz789", + "default_display_currecy_code": "abc123", "default_display_currecy_symbol": "xyz789", "default_display_currency_code": "xyz789", "default_display_currency_symbol": "xyz789", @@ -1737,25 +1737,25 @@ query customer { "data": { "customer": { "addresses": [CustomerAddress], - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "xyz789", - "default_shipping": "xyz789", - "dob": "xyz789", - "email": "xyz789", - "firstname": "abc123", + "default_shipping": "abc123", + "dob": "abc123", + "email": "abc123", + "firstname": "xyz789", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, - "group_id": 987, - "id": 987, + "group_id": 123, + "id": 123, "is_subscribed": false, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "xyz789", "middlename": "abc123", "orders": CustomerOrders, @@ -1775,10 +1775,10 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", - "taxvat": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1873,19 +1873,19 @@ query customerCart { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "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, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -2151,9 +2151,9 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "xyz789", - "secure_token": "xyz789", - "secure_token_id": "abc123" + "paypal_url": "abc123", + "secure_token": "abc123", + "secure_token_id": "xyz789" } } } @@ -2260,7 +2260,7 @@ query getPaymentOrder( ```json { "cartId": "abc123", - "id": "xyz789" + "id": "abc123" } ``` @@ -2271,9 +2271,9 @@ query getPaymentOrder( "data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "xyz789", + "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } } } @@ -2432,14 +2432,14 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "abc123", + "message": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -2463,7 +2463,7 @@ Search for gift registries by specifying a registrant email address. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](#string) | The registrant's email. | #### Example @@ -2485,7 +2485,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -2495,11 +2495,11 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "abc123", "gift_registry_uid": "4", "location": "xyz789", - "name": "abc123", + "name": "xyz789", "type": "xyz789" } ] @@ -2541,7 +2541,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2553,8 +2553,8 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { { "event_date": "xyz789", "event_title": "abc123", - "gift_registry_uid": 4, - "location": "xyz789", + "gift_registry_uid": "4", + "location": "abc123", "name": "xyz789", "type": "xyz789" } @@ -2608,7 +2608,7 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", + "firstName": "xyz789", "lastName": "abc123", "giftRegistryTypeUid": 4 } @@ -2621,10 +2621,10 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "xyz789", + "gift_registry_uid": 4, + "location": "abc123", "name": "abc123", "type": "xyz789" } @@ -2668,7 +2668,7 @@ query giftRegistryTypes { GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ] } @@ -2770,30 +2770,30 @@ query guestOrder($input: OrderInformationInput!) { "guestOrder": { "applied_coupons": [AppliedCoupon], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "created_at": "xyz789", "credit_memos": [CreditMemo], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": 4, + "grand_total": 987.65, + "id": "4", "increment_id": "abc123", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", "order_date": "xyz789", - "order_number": "xyz789", + "order_number": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "xyz789", + "status": "abc123", "token": "abc123", "total": OrderTotal } @@ -2905,22 +2905,22 @@ query guestOrderByToken($input: OrderTokenInput!) { "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "grand_total": 123.45, - "id": "4", - "increment_id": "abc123", + "id": 4, + "increment_id": "xyz789", "invoices": [Invoice], "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", + "number": "xyz789", "order_date": "abc123", - "order_number": "abc123", + "order_number": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", "status": "xyz789", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -2994,7 +2994,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3038,7 +3038,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} ``` @@ -3070,7 +3070,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -3108,13 +3108,13 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": true}}} +{"data": {"isEmailAvailable": {"is_email_available": false}}} ``` @@ -3180,7 +3180,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -3200,16 +3200,16 @@ query negotiableQuote($uid: ID!) { "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -3286,7 +3286,7 @@ query negotiableQuoteTemplate($templateId: ID!) { "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, @@ -3299,7 +3299,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ], "status": "xyz789", "template_id": "4", - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -3629,7 +3629,7 @@ query products( ```json { - "search": "abc123", + "search": "xyz789", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3687,10 +3687,10 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "abc123", + "badge_position": "xyz789", "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, + "is_enabled": true, "language_code": "abc123", "minimum_score": 987.65, "website_key": "abc123" @@ -3711,7 +3711,7 @@ Return the full details for a specified product, category, or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3730,7 +3730,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -3740,7 +3740,7 @@ query route($url: String!) { "data": { "route": { "redirect_code": 987, - "relative_url": "abc123", + "relative_url": "xyz789", "type": "CMS_PAGE" } } @@ -3997,154 +3997,154 @@ query storeConfig { "absolute_footer": "abc123", "allow_gift_receipt": "abc123", "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "xyz789", + "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "abc123", + "allow_items": "xyz789", "allow_order": "abc123", - "allow_printed_card": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, "base_currency_code": "abc123", "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "xyz789", - "base_url": "abc123", + "base_media_url": "abc123", + "base_static_url": "abc123", + "base_url": "xyz789", "braintree_3dsecure_allowspecific": true, - "braintree_3dsecure_always_request_3ds": true, - "braintree_3dsecure_specificcountry": "abc123", - "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": true, - "braintree_ach_direct_debit_vault_active": false, - "braintree_applepay_merchant_name": "abc123", + "braintree_3dsecure_always_request_3ds": false, + "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_threshold_amount": "xyz789", + "braintree_3dsecure_verify_3dsecure": false, + "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_active": "xyz789", "braintree_cc_vault_cvv": true, - "braintree_environment": "abc123", - "braintree_googlepay_btn_color": "abc123", + "braintree_environment": "xyz789", + "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "xyz789", - "braintree_googlepay_merchant_id": "xyz789", + "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_redirect_on_fail": "xyz789", - "braintree_merchant_account_id": "abc123", + "braintree_local_payment_redirect_on_fail": "abc123", + "braintree_merchant_account_id": "xyz789", "braintree_paypal_button_location_cart_type_credit_color": "abc123", "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_credit_show": false, + "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_text_color": "xyz789", + "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": "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_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_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": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_show": true, + "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_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": "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": false, - "braintree_paypal_button_location_checkout_type_messaging_text_color": "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": "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": 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_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": "xyz789", - "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_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_logo": "abc123", + "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": "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": "xyz789", - "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_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": 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": "xyz789", - "braintree_paypal_display_on_shopping_cart": 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": false, - "braintree_paypal_send_cart_line_items": true, + "braintree_paypal_require_billing_address": true, + "braintree_paypal_send_cart_line_items": false, "braintree_paypal_vault_active": false, - "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": 123, - "catalog_default_sort_by": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "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": "abc123", - "check_money_order_min_order_total": "xyz789", + "check_money_order_enabled": true, + "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": "abc123", - "check_money_order_payment_from_specific_countries": "xyz789", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 987, + "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", "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", + "cms_no_route": "xyz789", "code": "abc123", - "configurable_thumbnail_source": "abc123", + "configurable_thumbnail_source": "xyz789", "contact_enabled": true, "copyright": "xyz789", "countries_with_required_region": "xyz789", "create_account_confirmation": true, - "customer_access_token_lifetime": 987.65, + "customer_access_token_lifetime": 123.45, "default_country": "xyz789", - "default_description": "abc123", + "default_description": "xyz789", "default_display_currency_code": "abc123", - "default_keywords": "abc123", + "default_keywords": "xyz789", "default_title": "abc123", "demonotice": 123, "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", "front": "xyz789", - "grid_per_page": 123, - "grid_per_page_values": "abc123", + "grid_per_page": 987, + "grid_per_page_values": "xyz789", "head_includes": "abc123", - "head_shortcut_icon": "abc123", + "head_shortcut_icon": "xyz789", "header_logo_src": "xyz789", "id": 987, - "is_default_store": false, + "is_default_store": true, "is_default_store_group": true, - "is_guest_checkout_enabled": true, + "is_guest_checkout_enabled": false, "is_negotiable_quote_active": true, "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", + "list_mode": "abc123", + "list_per_page": 123, + "list_per_page_values": "xyz789", + "locale": "xyz789", "logo_alt": "abc123", "logo_height": 123, - "logo_width": 123, - "magento_reward_general_is_enabled": "abc123", + "logo_width": 987, + "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_general_min_points_balance": "xyz789", + "magento_reward_general_publish_history": "abc123", + "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", @@ -4153,57 +4153,57 @@ query storeConfig { "magento_reward_points_register": "xyz789", "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 987, - "maximum_number_of_wishlists": "abc123", - "minicart_display": false, - "minicart_max_items": 123, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": true, + "minicart_max_items": 987, "minimum_password_length": "xyz789", - "newsletter_enabled": false, - "no_route": "xyz789", - "optional_zip_countries": "abc123", + "newsletter_enabled": true, + "no_route": "abc123", + "optional_zip_countries": "xyz789", "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], - "payment_payflowpro_cc_vault_active": "xyz789", + "payment_payflowpro_cc_vault_active": "abc123", "printed_card_price": "abc123", "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "abc123", "product_url_suffix": "xyz789", "quickorder_active": true, "required_character_classes_number": "xyz789", - "returns_enabled": "xyz789", - "root_category_id": 123, + "returns_enabled": "abc123", + "root_category_id": 987, "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", + "sales_gift_wrapping": "abc123", "sales_printed_card": "abc123", "secure_base_link_url": "xyz789", "secure_base_media_url": "abc123", - "secure_base_static_url": "abc123", - "secure_base_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "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": 123, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, - "show_cms_breadcrumbs": 987, + "shopping_cart_display_zero_tax": true, + "show_cms_breadcrumbs": 123, "store_code": "4", - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "abc123", - "store_name": "xyz789", - "store_sort_order": 987, + "store_name": "abc123", + "store_sort_order": 123, "timezone": "abc123", "title_prefix": "abc123", "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": true, + "use_store_in_url": false, "website_code": 4, - "website_id": 987, - "website_name": "abc123", - "weight_unit": "xyz789", + "website_id": 123, + "website_name": "xyz789", + "weight_unit": "abc123", "welcome": "abc123", "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": true, @@ -4211,7 +4211,7 @@ query storeConfig { "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } } } @@ -4233,7 +4233,7 @@ Return the relative URL for a specified product, category or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4255,7 +4255,7 @@ query urlResolver($url: String!) { ##### Variables ```json -{"url": "xyz789"} +{"url": "abc123"} ``` ##### Response @@ -4264,11 +4264,11 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "xyz789", - "entity_uid": 4, - "id": 123, + "canonical_url": "abc123", + "entity_uid": "4", + "id": 987, "redirectCode": 123, - "relative_url": "abc123", + "relative_url": "xyz789", "type": "CMS_PAGE" } } @@ -4312,8 +4312,8 @@ query wishlist { "data": { "wishlist": { "items": [WishlistItem], - "items_count": 123, - "name": "abc123", + "items_count": 987, + "name": "xyz789", "sharing_code": "abc123", "updated_at": "abc123" } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-2.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-2.md deleted file mode 100644 index 13d74592f..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-2.md +++ /dev/null @@ -1,6466 +0,0 @@ -### CustomerAddress - -Contains detailed information about a customer's billing or shipping address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | -| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | -| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. | -| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "country_id": "xyz789", - "custom_attributes": [CustomerAddressAttribute], - "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, - "default_billing": true, - "default_shipping": true, - "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "abc123", - "id": 987, - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "abc123" -} -``` - - - -### CustomerAddressAttribute - -Specifies the attribute code and value of a customer address attribute. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](#string) | The value assigned to the customer address attribute. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "value": "abc123" -} -``` - - - -### CustomerAddressAttributeInput - -Specifies the attribute code and value of a customer attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "value": "abc123" -} -``` - - - -### CustomerAddressInput - -Contains details about a billing or shipping address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | Deprecated: use `country_code` instead. | -| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | Deprecated. Use custom_attributesV2 instead. | -| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "country_id": "AF", - "custom_attributes": [CustomerAddressAttributeInput], - "custom_attributesV2": [AttributeValueInput], - "default_billing": true, - "default_shipping": true, - "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" -} -``` - - - -### CustomerAddressRegion - -Defines the customer's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "xyz789", - "region_code": "xyz789", - "region_id": 987 -} -``` - - - -### CustomerAddressRegionInput - -Defines the customer's state or province. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "xyz789", - "region_code": "abc123", - "region_id": 123 -} -``` - - - -### CustomerAttributeMetadata - -Customer attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | - -#### Example - -```json -{ - "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": 987, - "options": [CustomAttributeOptionInterface], - "sort_order": 987, - "validate_rules": [ValidationRule] -} -``` - - - -### CustomerCreateInput - -An input object for creating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String!`](#string) | The customer's email address. | -| `firstname` - [`String!`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", - "dob": "xyz789", - "email": "xyz789", - "firstname": "abc123", - "gender": 987, - "is_subscribed": true, - "lastname": "abc123", - "middlename": "abc123", - "password": "xyz789", - "prefix": "xyz789", - "suffix": "xyz789", - "taxvat": "xyz789" -} -``` - - - -### CustomerDownloadableProduct - -Contains details about a single downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date` - [`String`](#string) | The date and time the purchase was made. | -| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | - -#### Example - -```json -{ - "date": "abc123", - "download_url": "abc123", - "order_increment_id": "abc123", - "remaining_downloads": "xyz789", - "status": "abc123" -} -``` - - - -### CustomerDownloadableProducts - -Contains a list of downloadable products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | - -#### Example - -```json -{"items": [CustomerDownloadableProduct]} -``` - - - -### CustomerInput - -An input object that assigns or updates customer attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | -| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "date_of_birth": "xyz789", - "dob": "abc123", - "email": "xyz789", - "firstname": "xyz789", - "gender": 123, - "is_subscribed": true, - "lastname": "abc123", - "middlename": "xyz789", - "password": "abc123", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "abc123" -} -``` - - - -### CustomerOrder - -Contains details about each of the customer's orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | -| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | -| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `email` - [`String`](#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | -| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](#string) | The order number. | -| `order_date` - [`String!`](#string) | The date the order was placed. | -| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | -| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](#string) | The delivery method for the order. | -| `status` - [`String!`](#string) | The current status of the order. | -| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | - -#### Example - -```json -{ - "applied_coupons": [AppliedCoupon], - "billing_address": OrderAddress, - "carrier": "xyz789", - "comments": [SalesCommentItem], - "created_at": "abc123", - "credit_memos": [CreditMemo], - "email": "xyz789", - "gift_message": GiftMessage, - "gift_receipt_included": false, - "gift_wrapping": GiftWrapping, - "grand_total": 987.65, - "id": "4", - "increment_id": "abc123", - "invoices": [Invoice], - "items": [OrderItemInterface], - "items_eligible_for_return": [OrderItemInterface], - "number": "xyz789", - "order_date": "abc123", - "order_number": "xyz789", - "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, - "returns": Returns, - "shipments": [OrderShipment], - "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "abc123", - "token": "xyz789", - "total": OrderTotal -} -``` - - - -### CustomerOrderSortInput - -CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | -| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "NUMBER"} -``` - - - -### CustomerOrderSortableField - -Specifies the field to use for sorting - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NUMBER` | Sorts customer orders by number | -| `CREATED_AT` | Sorts customer orders by created_at field | - -#### Example - -```json -""NUMBER"" -``` - - - -### CustomerOrders - -The collection of orders that match the conditions defined in the filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer orders. | - -#### Example - -```json -{ - "items": [CustomerOrder], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### CustomerOrdersFilterInput - -Identifies the filter to use for filtering orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | - -#### Example - -```json -{"number": FilterStringTypeInput} -``` - - - -### CustomerOutput - -Contains details about a newly-created or updated customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | - -#### Example - -```json -{"customer": Customer} -``` - - - -### CustomerPaymentTokens - -Contains payment tokens stored in the customer's vault. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | - -#### Example - -```json -{"items": [PaymentToken]} -``` - - - -### CustomerStoreCredit - -Contains store credit information with balance and history. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance_history` - [`CustomerStoreCreditHistory`](#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. | -| `current_balance` - [`Money`](#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | - -#### Example - -```json -{ - "balance_history": CustomerStoreCreditHistory, - "current_balance": Money, - "enabled": true -} -``` - - - -### CustomerStoreCreditHistory - -Lists changes to the amount of store credit available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of items returned. | - -#### Example - -```json -{ - "items": [CustomerStoreCreditHistoryItem], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerStoreCreditHistoryItem - -Contains store credit history information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `action` - [`String`](#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | - -#### Example - -```json -{ - "action": "abc123", - "actual_balance": Money, - "balance_change": Money, - "date_time_changed": "abc123" -} -``` - - - -### CustomerToken - -Contains a customer authorization token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | - -#### Example - -```json -{"token": "abc123"} -``` - - - -### CustomerUpdateInput - -An input object for updating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", - "dob": "xyz789", - "firstname": "abc123", - "gender": 123, - "is_subscribed": false, - "lastname": "xyz789", - "middlename": "abc123", - "prefix": "abc123", - "suffix": "abc123", - "taxvat": "xyz789" -} -``` - - - -### CustomizableAreaOption - -Contains information about a text area that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | - -#### Example - -```json -{ - "option_id": 123, - "product_sku": "xyz789", - "required": false, - "sort_order": 123, - "title": "abc123", - "uid": 4, - "value": CustomizableAreaValue -} -``` - - - -### CustomizableAreaValue - -Defines the price and sku of a product whose page contains a customized text area. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | - -#### Example - -```json -{ - "max_characters": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableCheckboxOption - -Contains information about a set of checkbox values that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 123, - "title": "abc123", - "uid": 4, - "value": [CustomizableCheckboxValue] -} -``` - - - -### CustomizableCheckboxValue - -Defines the price and sku of a product whose page contains a customized set of checkbox values. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 123, - "title": "abc123", - "uid": 4 -} -``` - - - -### CustomizableDateOption - -Contains information about a date picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "abc123", - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": CustomizableDateValue -} -``` - - - -### CustomizableDateTypeEnum - -Defines the customizable date type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `DATE` | | -| `DATE_TIME` | | -| `TIME` | | - -#### Example - -```json -""DATE"" -``` - - - -### CustomizableDateValue - -Defines the price and sku of a product whose page contains a customized date picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | - -#### Example - -```json -{ - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "type": "DATE", - "uid": "4" -} -``` - - - -### CustomizableDropDownOption - -Contains information about a drop down menu that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | - -#### Example - -```json -{ - "option_id": 987, - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": "4", - "value": [CustomizableDropDownValue] -} -``` - - - -### CustomizableDropDownValue - -Defines the price and sku of a product whose page contains a customized drop down menu. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableFieldOption - -Contains information about a text field that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | - -#### Example - -```json -{ - "option_id": 123, - "product_sku": "xyz789", - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": CustomizableFieldValue -} -``` - - - -### CustomizableFieldValue - -Defines the price and sku of a product whose page contains a customized text field. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | - -#### Example - -```json -{ - "max_characters": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableFileOption - -Contains information about a file picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "abc123", - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": CustomizableFileValue -} -``` - - - -### CustomizableFileValue - -Defines the price and sku of a product whose page contains a customized file picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `file_extension` - [`String`](#string) | The file extension to accept. | -| `image_size_x` - [`Int`](#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](#int) | The maximum height of an image. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | - -#### Example - -```json -{ - "file_extension": "abc123", - "image_size_x": 987, - "image_size_y": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "uid": 4 -} -``` - - - -### CustomizableMultipleOption - -Contains information about a multiselect that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 987, - "title": "xyz789", - "uid": 4, - "value": [CustomizableMultipleValue] -} -``` - - - -### CustomizableMultipleValue - -Defines the price and sku of a product whose page contains a customized multiselect. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | - -#### Example - -```json -{ - "option_type_id": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableOptionInput - -Defines a customizable option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`Int`](#int) | The customizable option ID of the product. | -| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](#string) | The string value of the option. | - -#### Example - -```json -{ - "id": 987, - "uid": 4, - "value_string": "abc123" -} -``` - - - -### CustomizableOptionInterface - -Contains basic information about a customizable option. It can be implemented by several types of configurable options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | - -#### Possible Types - -| CustomizableOptionInterface Types | -|----------------| -| [`CustomizableAreaOption`](#customizableareaoption) | -| [`CustomizableDateOption`](#customizabledateoption) | -| [`CustomizableDropDownOption`](#customizabledropdownoption) | -| [`CustomizableMultipleOption`](#customizablemultipleoption) | -| [`CustomizableFieldOption`](#customizablefieldoption) | -| [`CustomizableFileOption`](#customizablefileoption) | -| [`CustomizableRadioOption`](#customizableradiooption) | -| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableProductInterface - -Contains information about customizable product options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | - -#### Possible Types - -| CustomizableProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | - -#### Example - -```json -{"options": [CustomizableOptionInterface]} -``` - - - -### CustomizableRadioOption - -Contains information about a set of radio buttons that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | - -#### Example - -```json -{ - "option_id": 123, - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": 4, - "value": [CustomizableRadioValue] -} -``` - - - -### CustomizableRadioValue - -Defines the price and sku of a product whose page contains a customized set of radio buttons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | - -#### Example - -```json -{ - "option_type_id": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "xyz789", - "uid": "4" -} -``` - - - -### DeleteCompanyRoleOutput - -Contains the response to the request to delete the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | - -#### Example - -```json -{"success": false} -``` - - - -### DeleteCompanyTeamOutput - -Contains the status of the request to delete a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyUserOutput - -Contains the response to the request to delete the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | - -#### Example - -```json -{"success": false} -``` - - - -### DeleteCompareListOutput - -Contains the results of the request to delete a compare list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | - -#### Example - -```json -{"result": true} -``` - - - -### DeleteNegotiableQuoteError - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | - -#### Example - -```json -NegotiableQuoteInvalidStateError -``` - - - -### DeleteNegotiableQuoteOperationFailure - -Contains details about a failed delete operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 -} -``` - - - -### DeleteNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | - -#### Example - -```json -NegotiableQuoteUidOperationSuccess -``` - - - -### DeleteNegotiableQuoteTemplateInput - -Specifies the quote template id of the quote template to delete - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### DeleteNegotiableQuotesInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | - -#### Example - -```json -{"quote_uids": [4]} -``` - - - -### DeleteNegotiableQuotesOutput - -Contains a list of undeleted negotiable quotes the company user can view. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | -| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | - -#### Example - -```json -{ - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} -``` - - - -### DeletePaymentTokenOutput - -Indicates whether the request succeeded and returns the remaining customer payment tokens. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | - -#### Example - -```json -{ - "customerPaymentTokens": CustomerPaymentTokens, - "result": false -} -``` - - - -### DeletePurchaseOrderApprovalRuleError - -Contains details about an error that occurred when deleting an approval rule . - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | -| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | - -#### Example - -```json -{"message": "abc123", "type": "UNDEFINED"} -``` - - - -### DeletePurchaseOrderApprovalRuleErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `NOT_FOUND` | | - -#### Example - -```json -""UNDEFINED"" -``` - - - -### DeletePurchaseOrderApprovalRuleInput - -Specifies the IDs of the approval rules to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | - -#### Example - -```json -{"approval_rule_uids": ["4"]} -``` - - - -### DeletePurchaseOrderApprovalRuleOutput - -Contains any errors encountered while attempting to delete approval rules. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | - -#### Example - -```json -{"errors": [DeletePurchaseOrderApprovalRuleError]} -``` - - - -### DeleteRequisitionListItemsOutput - -Output of the request to remove items from the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### DeleteRequisitionListOutput - -Indicates whether the request to delete the requisition list was successful. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | - -#### Example - -```json -{"requisition_lists": RequisitionLists, "status": false} -``` - - - -### DeleteWishlistOutput - -Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | - -#### Example - -```json -{"status": false, "wishlists": [Wishlist]} -``` - - - -### Discount - -Specifies the discount type and value for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | -| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](#string) | A description of the discount. | -| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](#float) | Quote line item discount value. | - -#### Example - -```json -{ - "amount": Money, - "applied_to": "ITEM", - "coupon": AppliedCoupon, - "is_discounting_locked": true, - "label": "abc123", - "type": "abc123", - "value": 987.65 -} -``` - - - -### DownloadableCartItem - -An implementation for downloadable product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "id": "abc123", - "is_available": false, - "links": [DownloadableProductLinks], - "max_qty": 123.45, - "min_qty": 123.45, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples], - "uid": "4" -} -``` - - - -### DownloadableCreditMemoItem - -Defines downloadable product options for `CreditMemoItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 -} -``` - - - -### DownloadableFileTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | - -#### Example - -```json -""FILE"" -``` - - - -### DownloadableInvoiceItem - -Defines downloadable product options for `InvoiceItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 -} -``` - - - -### DownloadableItemsLinks - -Defines characteristics of the links for downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | - -#### Example - -```json -{ - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} -``` - - - -### DownloadableOrderItem - -Defines downloadable product options for `OrderItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "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": 123.45, - "quantity_refunded": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### DownloadableProduct - -Defines a product that the shopper downloads. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | -| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "downloadable_product_links": [ - DownloadableProductLinks - ], - "downloadable_product_samples": [ - DownloadableProductSamples - ], - "gift_message_available": "xyz789", - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "links_purchased_separately": 987, - "links_title": "xyz789", - "manufacturer": 987, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "abc123", - "staged": false, - "stock_status": "IN_STOCK", - "swatch_image": "abc123", - "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] -} -``` - - - -### DownloadableProductCartItemInput - -Defines a single downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | -| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "downloadable_product_links": [ - DownloadableProductLinksInput - ] -} -``` - - - -### DownloadableProductLinks - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | -| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](#float) | The price of the downloadable product. | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | - -#### Example - -```json -{ - "id": 987, - "is_shareable": true, - "link_type": "FILE", - "number_of_downloads": 123, - "price": 987.65, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "abc123", - "sort_order": 123, - "title": "abc123", - "uid": "4" -} -``` - - - -### DownloadableProductLinksInput - -Contains the link ID for the downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | - -#### Example - -```json -{"link_id": 123} -``` - - - -### DownloadableProductSamples - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the sample. | - -#### Example - -```json -{ - "id": 987, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "abc123", - "sort_order": 987, - "title": "abc123" -} -``` - - - -### DownloadableRequisitionListItem - -Contains details about downloadable products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "links": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples], - "uid": 4 -} -``` - - - -### DownloadableWishlistItem - -A downloadable product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "links_v2": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples] -} -``` - - - -### DuplicateNegotiableQuoteInput - -Identifies a quote to be duplicated - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | - -#### Example - -```json -{ - "duplicated_quote_uid": "4", - "quote_uid": "4" -} -``` - - - -### DuplicateNegotiableQuoteOutput - -Contains the newly created negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### DynamicBlock - -Contains a single dynamic block. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | - -#### Example - -```json -{ - "content": ComplexTextValue, - "uid": "4" -} -``` - - - -### DynamicBlockLocationEnum - -Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CONTENT` | | -| `HEADER` | | -| `FOOTER` | | -| `LEFT` | | -| `RIGHT` | | - -#### Example - -```json -""CONTENT"" -``` - - - -### DynamicBlockTypeEnum - -Indicates the selected Dynamic Blocks Rotator inline widget. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SPECIFIED` | | -| `CART_PRICE_RULE_RELATED` | | -| `CATALOG_PRICE_RULE_RELATED` | | - -#### Example - -```json -""SPECIFIED"" -``` - - - -### DynamicBlocks - -Contains an array of dynamic blocks. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | - -#### Example - -```json -{ - "items": [DynamicBlock], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### DynamicBlocksFilterInput - -Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | -| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | -| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | - -#### Example - -```json -{ - "dynamic_block_uids": ["4"], - "locations": ["CONTENT"], - "type": "SPECIFIED" -} -``` - - - -### EnteredCustomAttributeInput - -Contains details about a custom text attribute that the buyer entered. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "xyz789" -} -``` - - - -### EnteredOptionInput - -Defines a customer-entered option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](#string) | Text the customer entered. | - -#### Example - -```json -{ - "uid": "4", - "value": "xyz789" -} -``` - - - -### EntityUrl - -Contains the `uid`, `relative_url`, and `type` attributes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | -| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Example - -```json -{ - "canonical_url": "abc123", - "entity_uid": "4", - "id": 123, - "redirectCode": 987, - "relative_url": "abc123", - "type": "CMS_PAGE" -} -``` - - - -### ErrorInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Possible Types - -| ErrorInterface Types | -|----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### EstimateAddressInput - -Contains details about an address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | - -#### Example - -```json -{ - "country_code": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput -} -``` - - - -### EstimateTotalsInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | - -#### Example - -```json -{ - "address": EstimateAddressInput, - "cart_id": "xyz789", - "shipping_method": ShippingMethodInput -} -``` - - - -### EstimateTotalsOutput - -Estimate totals output. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | Cart after totals estimation | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ExchangeRate - -Lists the exchange rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | - -#### Example - -```json -{"currency_to": "xyz789", "rate": 987.65} -``` - - - -### FilterEqualTypeInput - -Defines a filter that matches the input exactly. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#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]`](#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 - -```json -{ - "eq": "abc123", - "in": ["xyz789"] -} -``` - - - -### FilterMatchTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FULL` | | -| `PARTIAL` | | - -#### Example - -```json -""FULL"" -``` - - - -### FilterMatchTypeInput - -Defines a filter that performs a fuzzy search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `match` - [`String`](#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`](#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 - -```json -{"match": "xyz789", "match_type": "FULL"} -``` - - - -### FilterRangeTypeInput - -Defines a filter that matches a range of values, such as prices or dates. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | - -#### Example - -```json -{ - "from": "abc123", - "to": "xyz789" -} -``` - - - -### FilterStringTypeInput - -Defines a filter for an input string. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | - -#### Example - -```json -{ - "eq": "abc123", - "in": ["xyz789"], - "match": "abc123" -} -``` - - - -### FilterTypeInput - -Defines the comparison operators that can be used in a filter. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Equals. | -| `finset` - [`[String]`](#string) | | -| `from` - [`String`](#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](#string) | Greater than. | -| `gteq` - [`String`](#string) | Greater than or equal to. | -| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](#string) | Less than. | -| `lteq` - [`String`](#string) | Less than or equal to. | -| `moreq` - [`String`](#string) | More than or equal to. | -| `neq` - [`String`](#string) | Not equal to. | -| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](#string) | Not null. | -| `null` - [`String`](#string) | Is null. | -| `to` - [`String`](#string) | To. Must be used with the `from` field. | - -#### Example - -```json -{ - "eq": "xyz789", - "finset": ["abc123"], - "from": "abc123", - "gt": "abc123", - "gteq": "abc123", - "in": ["xyz789"], - "like": "abc123", - "lt": "abc123", - "lteq": "xyz789", - "moreq": "abc123", - "neq": "abc123", - "nin": ["abc123"], - "notnull": "abc123", - "null": "abc123", - "to": "xyz789" -} -``` - - - -### FixedProductTax - -A single FPT that can be applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | - -#### Example - -```json -{ - "amount": Money, - "label": "abc123" -} -``` - - - -### FixedProductTaxDisplaySettings - -Lists display settings for the Fixed Product Tax. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""INCLUDE_FPT_WITHOUT_DETAILS"" -``` - - - -### Float - -The `Float` scalar type represents signed double-precision fractional -values as specified by -[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -#### Example - -```json -123.45 -``` - - - -### GenerateCustomerTokenAsAdminInput - -Identifies which customer requires remote shopping assistance. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | - -#### Example - -```json -{"customer_email": "xyz789"} -``` - - - -### GenerateCustomerTokenAsAdminOutput - -Contains the generated customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | - -#### Example - -```json -{"customer_token": "xyz789"} -``` - - - -### GenerateNegotiableQuoteFromTemplateInput - -Specifies the template id, from which to generate quote from. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### GenerateNegotiableQuoteFromTemplateOutput - -Contains the generated negotiable quote id. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | - -#### Example - -```json -{"negotiable_quote_uid": 4} -``` - - - -### GetPaymentSDKOutput - -Gets the payment SDK URLs and values - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | - -#### Example - -```json -{"sdkParams": [PaymentSDKParamsItem]} -``` - - - -### GiftCardAccount - -Contains details about the gift card account. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`Money`](#money) | The balance remaining on the gift card. | -| `code` - [`String`](#string) | The gift card account code. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | - -#### Example - -```json -{ - "balance": Money, - "code": "abc123", - "expiration_date": "xyz789" -} -``` - - - -### GiftCardAccountInput - -Contains the gift card code. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | - -#### Example - -```json -{"gift_card_code": "abc123"} -``` - - - -### GiftCardAmounts - -Contains the value of a gift card, the website that generated the card, and related information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_id` - [`Int`](#int) | An internal attribute ID. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | -| `value` - [`Float`](#float) | The value of the gift card. | -| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | -| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | -| `website_value` - [`Float`](#float) | The value of the gift card. | - -#### Example - -```json -{ - "attribute_id": 987, - "uid": 4, - "value": 987.65, - "value_id": 987, - "website_id": 123, - "website_value": 987.65 -} -``` - - - -### GiftCardCartItem - -Contains details about a gift card that has been added to a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender. | -| `sender_name` - [`String!`](#string) | The name of the sender. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "amount": Money, - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "id": "abc123", - "is_available": false, - "max_qty": 123.45, - "message": "abc123", - "min_qty": 987.65, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "abc123", - "uid": 4 -} -``` - - - -### GiftCardCreditMemoItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 -} -``` - - - -### GiftCardInvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 -} -``` - - - -### GiftCardItem - -Contains details about a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | - -#### Example - -```json -{ - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "abc123" -} -``` - - - -### GiftCardOptions - -Contains details about the sender, recipient, and amount of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](#string) | A message to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | - -#### Example - -```json -{ - "amount": Money, - "custom_giftcard_amount": Money, - "message": "abc123", - "recipient_email": "abc123", - "recipient_name": "xyz789", - "sender_email": "xyz789", - "sender_name": "abc123" -} -``` - - - -### GiftCardOrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "eligible_for_return": true, - "entered_options": [OrderItemOption], - "gift_card": GiftCardItem, - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "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": 987.65, - "quantity_refunded": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### GiftCardProduct - -Defines properties of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | -| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | -| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "allow_message": false, - "allow_open_amount": false, - "attribute_set_id": 123, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": "abc123", - "giftcard_amounts": [GiftCardAmounts], - "giftcard_type": "VIRTUAL", - "id": 987, - "image": ProductImage, - "is_redeemable": true, - "is_returnable": "abc123", - "lifetime": 987, - "manufacturer": 987, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 123, - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "open_amount_max": 123.45, - "open_amount_min": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "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": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 123.45 -} -``` - - - -### GiftCardRequisitionListItem - -Contains details about gift cards added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "gift_card_options": GiftCardOptions, - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" -} -``` - - - -### GiftCardShipmentItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Example - -```json -{ - "gift_card": GiftCardItem, - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 -} -``` - - - -### GiftCardTypeEnum - -Specifies the gift card type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `VIRTUAL` | | -| `PHYSICAL` | | -| `COMBINED` | | - -#### Example - -```json -""VIRTUAL"" -``` - - - -### GiftCardWishlistItem - -A single gift card added to a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "gift_card_options": GiftCardOptions, - "id": "4", - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### GiftMessage - -Contains the text of a gift message, its sender, and recipient - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | - -#### Example - -```json -{ - "from": "xyz789", - "message": "xyz789", - "to": "xyz789" -} -``` - - - -### GiftMessageInput - -Defines a gift message. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String!`](#string) | The name of the sender. | -| `message` - [`String!`](#string) | The text of the gift message. | -| `to` - [`String!`](#string) | The name of the recepient. | - -#### Example - -```json -{ - "from": "xyz789", - "message": "abc123", - "to": "xyz789" -} -``` - - - -### GiftOptionsPrices - -Contains prices for gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | -| `printed_card` - [`Money`](#money) | Price for the printed card. | - -#### Example - -```json -{ - "gift_wrapping_for_items": Money, - "gift_wrapping_for_order": Money, - "printed_card": Money -} -``` - - - -### GiftRegistry - -Contains details about a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | -| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | -| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | -| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | -| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | - -#### Example - -```json -{ - "created_at": "xyz789", - "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", - "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "xyz789", - "privacy_settings": "PRIVATE", - "registrants": [GiftRegistryRegistrant], - "shipping_address": CustomerAddress, - "status": "ACTIVE", - "type": GiftRegistryType, - "uid": "4" -} -``` - - - -### GiftRegistryDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": 4, - "group": "EVENT_INFORMATION", - "label": "abc123", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeGroup - -Defines the group type of a gift registry dynamic attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `EVENT_INFORMATION` | | -| `PRIVACY_SETTINGS` | | -| `REGISTRANT` | | -| `GENERAL_INFORMATION` | | -| `DETAILED_INFORMATION` | | -| `SHIPPING_ADDRESS` | | - -#### Example - -```json -""EVENT_INFORMATION"" -``` - - - -### GiftRegistryDynamicAttributeInput - -Defines a dynamic attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | - -#### Example - -```json -{ - "code": "4", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Possible Types - -| GiftRegistryDynamicAttributeInterface Types | -|----------------| -| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | -| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | - -#### Example - -```json -{ - "code": 4, - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeMetadata - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Example - -```json -{ - "attribute_group": "abc123", - "code": "4", - "input_type": "abc123", - "is_required": false, - "label": "xyz789", - "sort_order": 987 -} -``` - - - -### GiftRegistryDynamicAttributeMetadataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Possible Types - -| GiftRegistryDynamicAttributeMetadataInterface Types | -|----------------| -| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | - -#### Example - -```json -{ - "attribute_group": "xyz789", - "code": "4", - "input_type": "abc123", - "is_required": true, - "label": "abc123", - "sort_order": 987 -} -``` - - - -### GiftRegistryItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "abc123", - "product": ProductInterface, - "quantity": 987.65, - "quantity_fulfilled": 123.45, - "uid": 4 -} -``` - - - -### GiftRegistryItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Possible Types - -| GiftRegistryItemInterface Types | -|----------------| -| [`GiftRegistryItem`](#giftregistryitem) | - -#### Example - -```json -{ - "created_at": "abc123", - "note": "xyz789", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 123.45, - "uid": 4 -} -``` - - - -### GiftRegistryItemUserErrorInterface - -Contains the status and any errors that encountered with the customer's gift register item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Possible Types - -| GiftRegistryItemUserErrorInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{ - "status": true, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### GiftRegistryItemsUserError - -Contains details about an error that occurred when processing a gift registry item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | -| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | -| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | -| `message` - [`String!`](#string) | A localized error message. | -| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | - -#### Example - -```json -{ - "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": 4, - "message": "abc123", - "product_uid": 4 -} -``` - - - -### GiftRegistryItemsUserErrorType - -Defines the error type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""OUT_OF_STOCK"" -``` - - - -### GiftRegistryOutputInterface - -Contains the customer's gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | - -#### Possible Types - -| GiftRegistryOutputInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### GiftRegistryPrivacySettings - -Defines the privacy setting of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRIVATE` | | -| `PUBLIC` | | - -#### Example - -```json -""PRIVATE"" -``` - - - -### GiftRegistryRegistrant - -Contains details about a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryRegistrantDynamicAttribute - ], - "email": "abc123", - "firstname": "xyz789", - "lastname": "xyz789", - "uid": 4 -} -``` - - - -### GiftRegistryRegistrantDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": "4", - "label": "abc123", - "value": "xyz789" -} -``` - - - -### GiftRegistrySearchResult - -Contains the results of a gift registry search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | -| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](#string) | The location of the event. | -| `name` - [`String!`](#string) | The name of the gift registry owner. | -| `type` - [`String`](#string) | The type of event being held. | - -#### Example - -```json -{ - "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", - "type": "xyz789" -} -``` - - - -### GiftRegistryShippingAddressInput - -Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | -| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | - -#### Example - -```json -{"address_data": CustomerAddressInput, "address_id": 4} -``` - - - -### GiftRegistryStatus - -Defines the status of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ACTIVE` | | -| `INACTIVE` | | - -#### Example - -```json -""ACTIVE"" -``` - - - -### GiftRegistryType - -Contains details about a gift registry type. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | - -#### Example - -```json -{ - "dynamic_attributes_metadata": [ - GiftRegistryDynamicAttributeMetadataInterface - ], - "label": "xyz789", - "uid": 4 -} -``` - - - -### GiftWrapping - -Contains details about the selected or available gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | -| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | -| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | -| `price` - [`Money!`](#money) | The gift wrapping price. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | - -#### Example - -```json -{ - "design": "abc123", - "id": 4, - "image": GiftWrappingImage, - "price": Money, - "uid": "4" -} -``` - - - -### GiftWrappingImage - -Points to an image associated with a gift wrapping option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | - -#### Example - -```json -{ - "label": "abc123", - "url": "abc123" -} -``` - - - -### GooglePayButtonStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | - -#### Example - -```json -{ - "color": "abc123", - "height": 987, - "type": "xyz789" -} -``` - - - -### GooglePayConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "button_styles": GooglePayButtonStyles, - "code": "abc123", - "is_visible": true, - "payment_intent": "abc123", - "payment_source": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" -} -``` - - - -### GooglePayMethodInput - -Google Pay inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" -} -``` - - - -### GroupedProduct - -Defines a grouped product, which consists of simple standalone products that are presented as a group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": "abc123", - "id": 987, - "image": ProductImage, - "is_returnable": "xyz789", - "items": [GroupedProductItem], - "manufacturer": 123, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options_container": "xyz789", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "tier_price": 123.45, - "tier_prices": [ProductTierPrices], - "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": 4, - "updated_at": "xyz789", - "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 123.45 -} -``` - - - -### GroupedProductItem - -Contains information about an individual grouped product item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | -| `qty` - [`Float`](#float) | The quantity of this grouped product item. | - -#### Example - -```json -{ - "position": 123, - "product": ProductInterface, - "qty": 123.45 -} -``` - - - -### GroupedProductWishlistItem - -A grouped product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### HostedFieldsConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cc_vault_code` - [`String`](#string) | Vault payment method code | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds` - [`Boolean`](#boolean) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "cc_vault_code": "xyz789", - "code": "abc123", - "is_vault_enabled": false, - "is_visible": false, - "payment_intent": "xyz789", - "payment_source": "abc123", - "requires_card_details": true, - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "three_ds": false, - "title": "xyz789" -} -``` - - - -### HostedFieldsInput - -Hosted Fields payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cardBin` - [`String`](#string) | Card bin number | -| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | -| `cardLast4` - [`String`](#string) | Last four digits of the card | -| `holderName` - [`String`](#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cardBin": "xyz789", - "cardExpiryMonth": "abc123", - "cardExpiryYear": "abc123", - "cardLast4": "abc123", - "holderName": "abc123", - "is_active_payment_token_enabler": true, - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" -} -``` - - - -### HostedProInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "return_url": "abc123" -} -``` - - - -### HostedProUrl - -Contains the secure URL used for the Payments Pro Hosted Solution payment method. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | - -#### Example - -```json -{"secure_form_url": "xyz789"} -``` - - - -### HostedProUrlInput - -Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### HttpQueryParameter - -Contains target path parameters. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | - -#### Example - -```json -{ - "name": "abc123", - "value": "abc123" -} -``` - - - -### ID - -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 - -```json -4 -``` - - - -### ImageSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{ - "thumbnail": "xyz789", - "value": "xyz789" -} -``` - - - -### InputFilterEnum - -List of templates/filters applied to customer attribute input. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""NONE"" -``` - - - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. - -#### Example - -```json -123 -``` - - - -### InternalError - -Contains an error message when an internal error occurred. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "xyz789"} -``` - - - -### Invoice - -Contains invoice details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | -| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | -| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](#string) | Sequential invoice number. | -| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": "4", - "items": [InvoiceItemInterface], - "number": "abc123", - "total": InvoiceTotal -} -``` - - - -### InvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### InvoiceItemInterface - -Contains detailes about invoiced items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Possible Types - -| InvoiceItemInterface Types | -|----------------| -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | -| [`InvoiceItem`](#invoiceitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 -} -``` - - - -### InvoiceTotal - -Contains price details from an invoice. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### IsCompanyAdminEmailAvailableOutput - -Contains the response of a company admin email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsCompanyEmailAvailableOutput - -Contains the response of a company email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsCompanyRoleNameAvailableOutput - -Contains the response of a role name validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | - -#### Example - -```json -{"is_role_name_available": true} -``` - - - -### IsCompanyUserEmailAvailableOutput - -Contains the response of a company user email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsEmailAvailableOutput - -Contains the result of the `isEmailAvailable` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### ItemNote - -The note object for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | -| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | -| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | -| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | -| `note` - [`String`](#string) | Note text. | -| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | - -#### Example - -```json -{ - "created_at": "xyz789", - "creator_id": 123, - "creator_type": 123, - "negotiable_quote_item_uid": 4, - "note": "xyz789", - "note_uid": 4 -} -``` - - - -### ItemSelectedBundleOption - -A list of options of the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](#string) | The label of the option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | -| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | - -#### Example - -```json -{ - "id": 4, - "label": "abc123", - "uid": 4, - "values": [ItemSelectedBundleOptionValue] -} -``` - - - -### ItemSelectedBundleOptionValue - -A list of values for the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](#money) | The price of the child bundle product. | -| `product_name` - [`String!`](#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | -| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | - -#### Example - -```json -{ - "id": "4", - "price": Money, - "product_name": "abc123", - "product_sku": "xyz789", - "quantity": 123.45, - "uid": 4 -} -``` - - - -### KeyValue - -Contains a key-value pair. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name part of the key/value pair. | -| `value` - [`String`](#string) | The value part of the key/value pair. | - -#### Example - -```json -{ - "name": "abc123", - "value": "xyz789" -} -``` - - - -### LayerFilter - -Contains information for rendering layered navigation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | - -#### Example - -```json -{ - "filter_items": [LayerFilterItemInterface], - "filter_items_count": 123, - "name": "xyz789", - "request_var": "xyz789" -} -``` - - - -### LayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 123, - "label": "abc123", - "value_string": "abc123" -} -``` - - - -### LayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Possible Types - -| LayerFilterItemInterface Types | -|----------------| -| [`LayerFilterItem`](#layerfilteritem) | -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{ - "items_count": 987, - "label": "xyz789", - "value_string": "abc123" -} -``` - - - -### LineItemNoteInput - -Sets quote item note. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `note` - [`String`](#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "note": "abc123", - "quote_item_uid": "4", - "quote_uid": "4" -} -``` - - - -### MediaGalleryEntry - -Defines characteristics about images and videos associated with a specific product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](#string) | The path of the image on the server. | -| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](#string) | Either `image` or `video`. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | - -#### Example - -```json -{ - "content": ProductMediaGalleryEntriesContent, - "disabled": false, - "file": "xyz789", - "id": 987, - "label": "abc123", - "media_type": "xyz789", - "position": 123, - "types": ["abc123"], - "uid": "4", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### MediaGalleryInterface - -Contains basic information about a product image or video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Possible Types - -| MediaGalleryInterface Types | -|----------------| -| [`ProductImage`](#productimage) | -| [`ProductVideo`](#productvideo) | - -#### Example - -```json -{ - "disabled": false, - "label": "abc123", - "position": 987, - "url": "abc123" -} -``` - - - -### MessageStyleLogo - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | - -#### Example - -```json -{"type": "xyz789"} -``` - - - -### MessageStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `layout` - [`String`](#string) | The message layout | -| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | - -#### Example - -```json -{ - "layout": "xyz789", - "logo": MessageStyleLogo -} -``` - - - -### Money - -Defines a monetary value, including a numeric value and a currency code. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](#float) | A number expressing a monetary value. | - -#### Example - -```json -{"currency": "AFN", "value": 123.45} -``` - - - -### MoveCartItemsToGiftRegistryOutput - -Contains the customer's gift registry and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Example - -```json -{ - "gift_registry": GiftRegistry, - "status": false, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### MoveItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be moved. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | - -#### Example - -```json -{"requisitionListItemUids": ["4"]} -``` - - - -### MoveItemsBetweenRequisitionListsOutput - -Output of the request to move items to another requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | - -#### Example - -```json -{ - "destination_requisition_list": RequisitionList, - "source_requisition_list": RequisitionList -} -``` - - - -### MoveLineItemToRequisitionListInput - -Move Line Item to Requisition List. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | - -#### Example - -```json -{ - "quote_item_uid": "4", - "quote_uid": 4, - "requisition_list_uid": 4 -} -``` - - - -### MoveLineItemToRequisitionListOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### MoveProductsBetweenWishlistsOutput - -Contains the source and target wish lists after moving products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | - -#### Example - -```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} -``` - - - -### NegotiableQuote - -Contains details about a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | -| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](#string) | The email address of the company user. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | -| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | - -#### Example - -```json -{ - "available_payment_methods": [AvailablePaymentMethod], - "billing_address": NegotiableQuoteBillingAddress, - "buyer": NegotiableQuoteUser, - "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "abc123", - "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, - "items": [CartItemInterface], - "name": "abc123", - "prices": CartPrices, - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "SUBMITTED", - "total_quantity": 987.65, - "uid": "4", - "updated_at": "abc123" -} -``` - - - -### NegotiableQuoteAddressCountry - -Defines the company's country. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | - -#### Example - -```json -{ - "code": "abc123", - "label": "abc123" -} -``` - - - -### NegotiableQuoteAddressInput - -Defines the billing or shipping address to be applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company name. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | - -#### Example - -```json -{ - "city": "abc123", - "company": "xyz789", - "country_code": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", - "postcode": "abc123", - "region": "xyz789", - "region_id": 987, - "save_in_address_book": false, - "street": ["abc123"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteAddressInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Possible Types - -| NegotiableQuoteAddressInterface Types | -|----------------| -| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | -| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | - -#### Example - -```json -{ - "city": "abc123", - "company": "abc123", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "abc123", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteAddressRegion - -Defines the company's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The address region code. | -| `label` - [`String`](#string) | The display name of the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "code": "abc123", - "label": "abc123", - "region_id": 987 -} -``` - - - -### NegotiableQuoteBillingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Example - -```json -{ - "city": "abc123", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "telephone": "abc123" -} -``` - - - -### NegotiableQuoteBillingAddressInput - -Defines the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "same_as_shipping": false, - "use_for_shipping": true -} -``` - - - -### NegotiableQuoteComment - -Contains a single plain text comment from either the buyer or seller. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | -| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](#string) | The plain text comment. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | - -#### Example - -```json -{ - "author": NegotiableQuoteUser, - "created_at": "xyz789", - "creator_type": "BUYER", - "text": "xyz789", - "uid": "4" -} -``` - - - -### NegotiableQuoteCommentCreatorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BUYER` | | -| `SELLER` | | - -#### Example - -```json -""BUYER"" -``` - - - -### NegotiableQuoteCommentInput - -Contains the commend provided by the buyer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | - -#### Example - -```json -{"comment": "xyz789"} -``` - - - -### NegotiableQuoteCustomLogChange - -Contains custom log entries added by third-party extensions. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_value` - [`String!`](#string) | The new entry content. | -| `old_value` - [`String`](#string) | The previous entry in the custom log. | -| `title` - [`String!`](#string) | The title of the custom log entry. | - -#### Example - -```json -{ - "new_value": "xyz789", - "old_value": "xyz789", - "title": "xyz789" -} -``` - - - -### NegotiableQuoteFilterInput - -Defines a filter to limit the negotiable quotes to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | - -#### Example - -```json -{ - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput -} -``` - - - -### NegotiableQuoteHistoryChanges - -Contains a list of changes to a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | - -#### Example - -```json -{ - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange -} -``` - - - -### NegotiableQuoteHistoryCommentChange - -Contains a comment submitted by a seller or buyer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | - -#### Example - -```json -{"comment": "xyz789"} -``` - - - -### NegotiableQuoteHistoryEntry - -Contains details about a change for a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | -| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | -| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | - -#### Example - -```json -{ - "author": NegotiableQuoteUser, - "change_type": "CREATED", - "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", - "uid": "4" -} -``` - - - -### NegotiableQuoteHistoryEntryChangeType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CREATED` | | -| `UPDATED` | | -| `CLOSED` | | -| `UPDATED_BY_SYSTEM` | | - -#### Example - -```json -""CREATED"" -``` - - - -### NegotiableQuoteHistoryExpirationChange - -Contains a new expiration date and the previous date. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | - -#### Example - -```json -{ - "new_expiration": "abc123", - "old_expiration": "xyz789" -} -``` - - - -### NegotiableQuoteHistoryProductsRemovedChange - -Contains lists of products that have been removed from the catalog and negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | -| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | - -#### Example - -```json -{ - "products_removed_from_catalog": [4], - "products_removed_from_quote": [ProductInterface] -} -``` - - - -### NegotiableQuoteHistoryStatusChange - -Lists a new status change applied to a negotiable quote and the previous status. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | -| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | - -#### Example - -```json -{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} -``` - - - -### NegotiableQuoteHistoryStatusesChange - -Contains a list of status changes that occurred for the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | - -#### Example - -```json -{"changes": [NegotiableQuoteHistoryStatusChange]} -``` - - - -### NegotiableQuoteHistoryTotalChange - -Contains a new price and the previous price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_price` - [`Money`](#money) | The total price as a result of the change. | -| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | - -#### Example - -```json -{ - "new_price": Money, - "old_price": Money -} -``` - - - -### NegotiableQuoteInvalidStateError - -An error indicating that an operation was attempted on a negotiable quote in an invalid state. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### NegotiableQuoteItemQuantityInput - -Specifies the updated quantity of an item. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | - -#### Example - -```json -{"quantity": 987.65, "quote_item_uid": "4"} -``` - - - -### NegotiableQuotePaymentMethodInput - -Defines the payment method to be applied to the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | - -#### Example - -```json -{ - "code": "abc123", - "purchase_order_number": "abc123" -} -``` - - - -### NegotiableQuoteShippingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Example - -```json -{ - "available_shipping_methods": [AvailableShippingMethod], - "city": "xyz789", - "company": "abc123", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "abc123", - "region": NegotiableQuoteAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "telephone": "abc123" -} -``` - - - -### NegotiableQuoteShippingAddressInput - -Defines shipping addresses for the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "xyz789" -} -``` - - - -### NegotiableQuoteSortInput - -Defines the field to use to sort a list of negotiable quotes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} -``` - - - -### NegotiableQuoteSortableField - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""QUOTE_NAME"" -``` - - - -### NegotiableQuoteStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SUBMITTED` | | -| `PENDING` | | -| `UPDATED` | | -| `OPEN` | | -| `ORDERED` | | -| `CLOSED` | | -| `DECLINED` | | -| `EXPIRED` | | -| `DRAFT` | | - -#### Example - -```json -""SUBMITTED"" -``` - - - -### NegotiableQuoteTemplate - -Contains details about a negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | - -#### Example - -```json -{ - "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": 987, - "name": "abc123", - "notifications": [QuoteTemplateNotificationMessage], - "prices": CartPrices, - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "xyz789", - "template_id": 4, - "total_quantity": 987.65 -} -``` - - - -### NegotiableQuoteTemplateFilterInput - -Defines a filter to limit the negotiable quotes to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | - -#### Example - -```json -{ - "state": FilterEqualTypeInput, - "status": FilterEqualTypeInput -} -``` - - - -### NegotiableQuoteTemplateGridItem - -Contains data for a negotiable quote template in a grid. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `state` - [`String!`](#string) | State of the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "activated_at": "abc123", - "company_name": "xyz789", - "expiration_date": "abc123", - "is_min_max_qty_used": false, - "last_shared_at": "xyz789", - "max_order_commitment": 987, - "min_negotiated_grand_total": 123.45, - "min_order_commitment": 987, - "name": "xyz789", - "orders_placed": 987, - "sales_rep_name": "xyz789", - "state": "xyz789", - "status": "xyz789", - "submitted_by": "abc123", - "template_id": "4" -} -``` - - - -### NegotiableQuoteTemplateItemQuantityInput - -Specifies the updated quantity of an item. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | - -#### Example - -```json -{ - "item_id": "4", - "max_qty": 987.65, - "min_qty": 123.45, - "quantity": 987.65 -} -``` - - - -### NegotiableQuoteTemplateShippingAddressInput - -Defines shipping addresses for the negotiable quote template. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "abc123" -} -``` - - - -### NegotiableQuoteTemplateSortInput - -Defines the field to use to sort a list of negotiable quotes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} -``` - - - -### NegotiableQuoteTemplateSortableField - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | -| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | - -#### Example - -```json -""TEMPLATE_ID"" -``` - - - -### NegotiableQuoteTemplatesOutput - -Contains a list of negotiable templates that match the specified filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | - -#### Example - -```json -{ - "items": [NegotiableQuoteTemplateGridItem], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 123 -} -``` - - - -### NegotiableQuoteUidNonFatalResultInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Possible Types - -| NegotiableQuoteUidNonFatalResultInterface Types | -|----------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### NegotiableQuoteUidOperationSuccess - -Contains details about a successful operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### NegotiableQuoteUser - -A limited view of a Buyer or Seller in the negotiable quote process. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | - -#### Example - -```json -{ - "firstname": "abc123", - "lastname": "abc123" -} -``` - - - -### NegotiableQuotesOutput - -Contains a list of negotiable that match the specified filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | - -#### Example - -```json -{ - "items": [NegotiableQuote], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 987 -} -``` - - - -### NoSuchEntityUidError - -Contains an error message when an invalid UID was specified. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | - -#### Example - -```json -{ - "message": "abc123", - "uid": "4" -} -``` - - - -### OpenNegotiableQuoteTemplateInput - -Specifies the quote template id to open quote template. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### Order - -Contains the order ID. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | - -#### Example - -```json -{ - "order_id": "xyz789", - "order_number": "abc123" -} -``` - - - -### OrderAddress - -Contains detailed information about an order's billing and shipping addresses. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `fax` - [`String`](#string) | The fax number. | -| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | The state or province name. | -| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", - "region": "xyz789", - "region_id": "4", - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "abc123" -} -``` - - - -### OrderInformationInput - -Input to retrieve an order based on details. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `number` - [`String!`](#string) | Order number. | -| `postcode` - [`String!`](#string) | Order billing address postcode. | - -#### Example - -```json -{ - "email": "abc123", - "number": "xyz789", - "postcode": "xyz789" -} -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-4.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-4.md deleted file mode 100644 index eae11857c..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-4.md +++ /dev/null @@ -1,2242 +0,0 @@ -### StoreConfig - -Contains information about a store's configuration. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `<body>` tag. | -| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | -| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | -| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | -| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | -| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | -| `base_currency_code` - [`String`](#string) | The base currency code. | -| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | -| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | -| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | -| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | -| `braintree_3dsecure_allowspecific` - [`Boolean`](#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | -| `braintree_3dsecure_always_request_3ds` - [`Boolean`](#boolean) | Braintree 3D Secure, always request 3D Secure flag. | -| `braintree_3dsecure_specificcountry` - [`String`](#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`](#string) | Braintree 3D Secure, threshold above which 3D Secure should be requested. | -| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](#boolean) | Braintree 3D Secure enabled/active status. | -| `braintree_ach_direct_debit_vault_active` - [`Boolean`](#boolean) | Braintree ACH vault status. | -| `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | -| `braintree_applepay_vault_active` - [`Boolean`](#boolean) | Braintree Apple Pay vault status. | -| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `braintree_cc_vault_cvv` - [`Boolean`](#boolean) | Braintree cc vault CVV re-verification enabled status. | -| `braintree_environment` - [`String`](#string) | Braintree environment. | -| `braintree_googlepay_btn_color` - [`String`](#string) | Braintree Google Pay button color. | -| `braintree_googlepay_cctypes` - [`String`](#string) | Braintree Google Pay Card types supported. | -| `braintree_googlepay_merchant_id` - [`String`](#string) | Braintree Google Pay merchant ID. | -| `braintree_googlepay_vault_active` - [`Boolean`](#boolean) | Braintree Google Pay vault status. | -| `braintree_local_payment_allowed_methods` - [`String`](#string) | Braintree Local Payment Methods allowed payment methods. | -| `braintree_local_payment_fallback_button_text` - [`String`](#string) | Braintree Local Payment Methods fallback button text. | -| `braintree_local_payment_redirect_on_fail` - [`String`](#string) | Braintree Local Payment Methods redirect URL on failed payment. | -| `braintree_merchant_account_id` - [`String`](#string) | Braintree Merchant Account ID. | -| `braintree_paypal_button_location_cart_type_credit_color` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_credit_label` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | -| `braintree_paypal_button_location_cart_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style layout. | -| `braintree_paypal_button_location_cart_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo. | -| `braintree_paypal_button_location_cart_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo position. | -| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | -| `braintree_paypal_button_location_cart_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | -| `braintree_paypal_button_location_cart_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | -| `braintree_paypal_button_location_cart_type_paypal_color` - [`String`](#string) | Braintree PayPal mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_paypal_label` - [`String`](#string) | Braintree PayPal mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_paypal_shape` - [`String`](#string) | Braintree PayPal mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal mini-cart & cart button show. | -| `braintree_paypal_button_location_checkout_type_credit_color` - [`String`](#string) | Braintree PayPal Credit checkout button style color. | -| `braintree_paypal_button_location_checkout_type_credit_label` - [`String`](#string) | Braintree PayPal Credit checkout button style label. | -| `braintree_paypal_button_location_checkout_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit checkout button show status. | -| `braintree_paypal_button_location_checkout_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style layout. | -| `braintree_paypal_button_location_checkout_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo. | -| `braintree_paypal_button_location_checkout_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo position. | -| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging checkout show status. | -| `braintree_paypal_button_location_checkout_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | -| `braintree_paypal_button_location_checkout_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later checkout button style color. | -| `braintree_paypal_button_location_checkout_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later checkout button style label. | -| `braintree_paypal_button_location_checkout_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later checkout button show status. | -| `braintree_paypal_button_location_checkout_type_paypal_color` - [`String`](#string) | Braintree PayPal checkout button style color. | -| `braintree_paypal_button_location_checkout_type_paypal_label` - [`String`](#string) | Braintree PayPal checkout button style label. | -| `braintree_paypal_button_location_checkout_type_paypal_shape` - [`String`](#string) | Braintree PayPal checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal checkout button show. | -| `braintree_paypal_button_location_productpage_type_credit_color` - [`String`](#string) | Braintree PayPal Credit PDP button style color. | -| `braintree_paypal_button_location_productpage_type_credit_label` - [`String`](#string) | Braintree PayPal Credit PDP button style label. | -| `braintree_paypal_button_location_productpage_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit PDP button show status. | -| `braintree_paypal_button_location_productpage_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style layout. | -| `braintree_paypal_button_location_productpage_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo. | -| `braintree_paypal_button_location_productpage_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo position. | -| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging PDP show status. | -| `braintree_paypal_button_location_productpage_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style text color. | -| `braintree_paypal_button_location_productpage_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later PDP button style color. | -| `braintree_paypal_button_location_productpage_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later PDP button style label. | -| `braintree_paypal_button_location_productpage_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later PDP button show status. | -| `braintree_paypal_button_location_productpage_type_paypal_color` - [`String`](#string) | Braintree PayPal PDP button style color. | -| `braintree_paypal_button_location_productpage_type_paypal_label` - [`String`](#string) | Braintree PayPal PDP button style label. | -| `braintree_paypal_button_location_productpage_type_paypal_shape` - [`String`](#string) | Braintree PayPal PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal PDP button show. | -| `braintree_paypal_credit_uk_merchant_name` - [`String`](#string) | Braintree PayPal Credit Merchant Name on the FCA Register. | -| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](#boolean) | Should display Braintree PayPal in mini-cart & cart? | -| `braintree_paypal_merchant_country` - [`String`](#string) | Braintree PayPal merchant's country. | -| `braintree_paypal_merchant_name_override` - [`String`](#string) | Braintree PayPal override for Merchant Name. | -| `braintree_paypal_require_billing_address` - [`Boolean`](#boolean) | Does Braintree PayPal require the customer's billing address? | -| `braintree_paypal_send_cart_line_items` - [`Boolean`](#boolean) | Does Braintree PayPal require the order line items? | -| `braintree_paypal_vault_active` - [`Boolean`](#boolean) | Braintree PayPal vault status. | -| `cart_expires_in_days` - [`Int`](#int) | Extended Config Data - checkout/cart/delete_quote_after | -| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | -| `cart_printed_card` - [`String`](#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`](#int) | Extended Config Data - checkout/cart_link/use_qty | -| `catalog_default_sort_by` - [`String`](#string) | The default sort order of the search results list. | -| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | -| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | -| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | -| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | -| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | -| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | -| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | -| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | -| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | -| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | -| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | -| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | -| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | -| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | -| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | -| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | -| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | -| `default_description` - [`String`](#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`](#string) | The default display currency code. | -| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | -| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | -| `demonotice` - [`Int`](#int) | Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes). | -| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | -| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | -| `front` - [`String`](#string) | The landing page that is associated with the base URL. | -| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | -| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | -| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `<head>` tag. | -| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | -| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | -| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | Extended Config Data - checkout/options/guest_checkout | -| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | Extended Config Data - checkout/options/onepage_checkout_enabled | -| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | -| `list_mode` - [`String`](#string) | The format of the search results list. | -| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | -| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | -| `locale` - [`String`](#string) | The store locale. | -| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | -| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | -| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | -| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | -| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | -| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | -| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | -| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | -| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | -| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | -| `max_items_in_order_summary` - [`Int`](#int) | Extended Config Data - checkout/options/max_items_display_count | -| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | -| `minicart_display` - [`Boolean`](#boolean) | Extended Config Data - checkout/sidebar/display | -| `minicart_max_items` - [`Int`](#int) | Extended Config Data - checkout/sidebar/count | -| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | -| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | -| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | -| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | -| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | -| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | -| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | -| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | -| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | -| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | -| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | -| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | -| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | -| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | -| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | -| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | -| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | -| `store_group_name` - [`String`](#string) | The label assigned to the store group. | -| `store_name` - [`String`](#string) | The label assigned to the store view. | -| `store_sort_order` - [`Int`](#int) | The store view sort order. | -| `timezone` - [`String`](#string) | The time zone of the store. | -| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | -| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | -| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | -| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](#id) | The unique ID for the website. | -| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | -| `website_name` - [`String`](#string) | The label assigned to the website. | -| `weight_unit` - [`String`](#string) | The unit of weight. | -| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | -| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | -| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | -| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | - -#### Example - -```json -{ - "absolute_footer": "xyz789", - "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": "xyz789", - "allow_order": "abc123", - "allow_printed_card": "abc123", - "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "xyz789", - "base_media_url": "xyz789", - "base_static_url": "abc123", - "base_url": "xyz789", - "braintree_3dsecure_allowspecific": false, - "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": false, - "braintree_applepay_merchant_name": "xyz789", - "braintree_applepay_vault_active": false, - "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": true, - "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "xyz789", - "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": "xyz789", - "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": "xyz789", - "braintree_paypal_button_location_cart_type_credit_shape": "xyz789", - "braintree_paypal_button_location_cart_type_credit_show": false, - "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": "abc123", - "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": "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": "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_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": "abc123", - "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": "xyz789", - "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_show": false, - "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789", - "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": true, - "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", - "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": "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_shape": "xyz789", - "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": "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": "xyz789", - "braintree_paypal_display_on_shopping_cart": true, - "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "abc123", - "braintree_paypal_require_billing_address": true, - "braintree_paypal_send_cart_line_items": false, - "braintree_paypal_vault_active": true, - "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", - "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": "xyz789", - "check_money_order_enable_for_specific_countries": true, - "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": "xyz789", - "check_money_order_new_order_status": "xyz789", - "check_money_order_payment_from_specific_countries": "xyz789", - "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", - "cms_home_page": "xyz789", - "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", - "code": "abc123", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, - "copyright": "xyz789", - "countries_with_required_region": "abc123", - "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", - "demonotice": 987, - "display_state_if_optional": true, - "enable_multiple_wishlists": "xyz789", - "front": "abc123", - "grid_per_page": 987, - "grid_per_page_values": "abc123", - "head_includes": "xyz789", - "head_shortcut_icon": "abc123", - "header_logo_src": "xyz789", - "id": 987, - "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": "abc123", - "list_mode": "xyz789", - "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": "abc123", - "magento_reward_general_is_enabled_on_front": "xyz789", - "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_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": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "abc123", - "minicart_display": false, - "minicart_max_items": 123, - "minimum_password_length": "xyz789", - "newsletter_enabled": true, - "no_route": "xyz789", - "optional_zip_countries": "xyz789", - "order_cancellation_enabled": false, - "order_cancellation_reasons": [CancellationReason], - "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "abc123", - "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": "abc123", - "returns_enabled": "abc123", - "root_category_id": 987, - "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", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", - "send_friend": SendFriendConfiguration, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 987, - "shopping_cart_display_subtotal": 123, - "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": "abc123", - "store_sort_order": 987, - "timezone": "abc123", - "title_prefix": "xyz789", - "title_separator": "abc123", - "title_suffix": "abc123", - "use_store_in_url": false, - "website_code": 4, - "website_id": 987, - "website_name": "abc123", - "weight_unit": "abc123", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "xyz789" -} -``` - - - -### StorefrontProperties - -Indicates where an attribute can be displayed. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | - -#### Example - -```json -{ - "position": 123, - "use_in_layered_navigation": "NO", - "use_in_product_listing": true, - "use_in_search_results_layered_navigation": true, - "visible_on_catalog_pages": true -} -``` - - - -### String - -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 - -```json -"xyz789" -``` - - - -### SubmitNegotiableQuoteTemplateForReviewInput - -Specifies the quote template properties to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | -| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "comment": "xyz789", - "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "abc123", - "template_id": 4 -} -``` - - - -### SubscribeEmailToNewsletterOutput - -Contains the result of the `subscribeEmailToNewsletter` operation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | - -#### Example - -```json -{"status": "NOT_ACTIVE"} -``` - - - -### SubscriptionStatusesEnum - -Indicates the status of the request. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_ACTIVE` | | -| `SUBSCRIBED` | | -| `UNSUBSCRIBED` | | -| `UNCONFIRMED` | | - -#### Example - -```json -""NOT_ACTIVE"" -``` - - - -### SwatchData - -Describes the swatch type and a value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | -| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | - -#### Example - -```json -{ - "type": "abc123", - "value": "abc123" -} -``` - - - -### SwatchDataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Possible Types - -| SwatchDataInterface Types | -|----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | - -#### Example - -```json -{"value": "abc123"} -``` - - - -### SwatchInputTypeEnum - -Swatch attribute metadata input types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `DROPDOWN` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `UNDEFINED` | | -| `VISUAL` | | -| `WEIGHT` | | - -#### Example - -```json -""BOOLEAN"" -``` - - - -### SwatchLayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 123, - "label": "xyz789", - "swatch_data": SwatchData, - "value_string": "xyz789" -} -``` - - - -### SwatchLayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | - -#### Possible Types - -| SwatchLayerFilterItemInterface Types | -|----------------| -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{"swatch_data": SwatchData} -``` - - - -### SyncPaymentOrderInput - -Synchronizes the payment order details - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cartId": "abc123", - "id": "abc123" -} -``` - - - -### TaxItem - -Contains tax item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | -| `title` - [`String!`](#string) | A title that describes the tax. | - -#### Example - -```json -{ - "amount": Money, - "rate": 987.65, - "title": "xyz789" -} -``` - - - -### TaxWrappingEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `DISPLAY_EXCLUDING_TAX` | | -| `DISPLAY_INCLUDING_TAX` | | -| `DISPLAY_TYPE_BOTH` | | - -#### Example - -```json -""DISPLAY_EXCLUDING_TAX"" -``` - - - -### TextSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{"value": "abc123"} -``` - - - -### TierPrice - -Defines a price based on the quantity purchased. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](#money) | The price of the product at this tier. | -| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "quantity": 987.65 -} -``` - - - -### UpdateCartItemsInput - -Modifies the specified items in the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | - -#### Example - -```json -{ - "cart_id": "abc123", - "cart_items": [CartItemUpdateInput] -} -``` - - - -### UpdateCartItemsOutput - -Contains details about the cart after updating items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### UpdateCompanyOutput - -Contains the response to the request to update the company. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | - -#### Example - -```json -{"company": Company} -``` - - - -### UpdateCompanyRoleOutput - -Contains the response to the request to update the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | - -#### Example - -```json -{"role": CompanyRole} -``` - - - -### UpdateCompanyStructureOutput - -Contains the response to the request to update the company structure. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | - -#### Example - -```json -{"company": Company} -``` - - - -### UpdateCompanyTeamOutput - -Contains the response to the request to update a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | - -#### Example - -```json -{"team": CompanyTeam} -``` - - - -### UpdateCompanyUserOutput - -Contains the response to the request to update the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | - -#### Example - -```json -{"user": Customer} -``` - - - -### UpdateGiftRegistryInput - -Defines updates to a `GiftRegistry` object. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](#string) | The updated name of the event. | -| `message` - [`String`](#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "xyz789", - "message": "xyz789", - "privacy_settings": "PRIVATE", - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" -} -``` - - - -### UpdateGiftRegistryItemInput - -Defines updates to an item in a gift registry. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](#string) | The updated description of the item. | -| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | - -#### Example - -```json -{ - "gift_registry_item_uid": 4, - "note": "xyz789", - "quantity": 123.45 -} -``` - - - -### UpdateGiftRegistryItemsOutput - -Contains the results of a request to update gift registry items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateGiftRegistryOutput - -Contains the results of a request to update a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateGiftRegistryRegistrantInput - -Defines updates to an existing registrant. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | -| `firstname` - [`String`](#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](#string) | The updated last name of the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "xyz789", - "firstname": "xyz789", - "gift_registry_registrant_uid": "4", - "lastname": "xyz789" -} -``` - - - -### UpdateGiftRegistryRegistrantsOutput - -Contains the results a request to update registrants. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateNegotiableQuoteItemsQuantityOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### UpdateNegotiableQuoteQuantitiesInput - -Specifies the items to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 -} -``` - - - -### UpdateNegotiableQuoteTemplateItemsQuantityOutput - -Contains the updated negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | - -#### Example - -```json -{"quote_template": NegotiableQuoteTemplate} -``` - - - -### UpdateNegotiableQuoteTemplateQuantitiesInput - -Specifies the items to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": 4 -} -``` - - - -### UpdateProductsInWishlistOutput - -Contains the customer's wish list and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | - -#### Example - -```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} -``` - - - -### UpdatePurchaseOrderApprovalRuleInput - -Defines the changes to be made to an approval rule. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](#string) | The updated approval rule description. | -| `name` - [`String`](#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | - -#### Example - -```json -{ - "applies_to": [4], - "approvers": ["4"], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "abc123", - "status": "ENABLED", - "uid": 4 -} -``` - - - -### UpdateRequisitionListInput - -An input object that defines which requistion list characteristics to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | - -#### Example - -```json -{ - "description": "xyz789", - "name": "xyz789" -} -``` - - - -### UpdateRequisitionListItemsInput - -Defines which items in a requisition list to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "item_id": "4", - "quantity": 987.65, - "selected_options": ["abc123"] -} -``` - - - -### UpdateRequisitionListItemsOutput - -Output of the request to update items in the specified requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateRequisitionListOutput - -Output of the request to rename the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateWishlistOutput - -Contains the name and visibility of an updated wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | - -#### Example - -```json -{ - "name": "abc123", - "uid": "4", - "visibility": "PUBLIC" -} -``` - - - -### UrlRewrite - -Contains URL rewrite details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | - -#### Example - -```json -{ - "parameters": [HttpQueryParameter], - "url": "xyz789" -} -``` - - - -### UrlRewriteEntityTypeEnum - -This enumeration defines the entity type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CMS_PAGE` | | -| `PRODUCT` | | -| `CATEGORY` | | - -#### Example - -```json -""CMS_PAGE"" -``` - - - -### UseInLayeredNavigationOptions - -Defines whether the attribute is filterable in layered navigation. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NO` | | -| `FILTERABLE_WITH_RESULTS` | | -| `FILTERABLE_NO_RESULT` | | - -#### Example - -```json -""NO"" -``` - - - -### UserCompaniesInput - -Defines the input for returning matching companies the customer is assigned to. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](#companiessortinput) | Defines the sorting of the results. | - -#### Example - -```json -{ - "currentPage": 123, - "pageSize": 123, - "sort": [CompaniesSortInput] -} -``` - - - -### UserCompaniesOutput - -An object that contains a list of companies customer is assigned to. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | - -#### Example - -```json -{ - "items": [CompanyBasicInfo], - "page_info": SearchResultPageInfo -} -``` - - - -### ValidatePurchaseOrderError - -Contains details about a failed validation attempt. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | - -#### Example - -```json -{"message": "xyz789", "type": "NOT_FOUND"} -``` - - - -### ValidatePurchaseOrderErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | - -#### Example - -```json -""NOT_FOUND"" -``` - - - -### ValidatePurchaseOrdersInput - -Defines the purchase orders to be validated. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | - -#### Example - -```json -{"purchase_order_uids": [4]} -``` - - - -### ValidatePurchaseOrdersOutput - -Contains the results of validation attempts. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | - -#### Example - -```json -{ - "errors": [ValidatePurchaseOrderError], - "purchase_orders": [PurchaseOrder] -} -``` - - - -### ValidationRule - -Defines a customer attribute validation rule. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | - -#### Example - -```json -{ - "name": "DATE_RANGE_MAX", - "value": "abc123" -} -``` - - - -### ValidationRuleEnum - -List of validation rule names applied to a customer attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""DATE_RANGE_MAX"" -``` - - - -### VaultMethodInput - -Vault payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | -| `public_hash` - [`String`](#string) | The public hash of the token. | - -#### Example - -```json -{ - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "xyz789", - "public_hash": "xyz789" -} -``` - - - -### VaultTokenInput - -Contains required input for payment methods with Vault support. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | - -#### Example - -```json -{"public_hash": "xyz789"} -``` - - - -### VirtualCartItem - -An implementation for virtual product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "id": "xyz789", - "is_available": true, - "max_qty": 123.45, - "min_qty": 987.65, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" -} -``` - - - -### VirtualProduct - -Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": "abc123", - "id": 987, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "abc123", - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 987.65, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "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": "abc123", - "url_path": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website] -} -``` - - - -### VirtualProductCartItemInput - -Defines a single product to add to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} -``` - - - -### VirtualRequisitionListItem - -Contains details about virtual products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### VirtualWishlistItem - -Contains a virtual product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### Website - -Deprecated. It should not be used on the storefront. Contains information about a website. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | -| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "code": "xyz789", - "default_group_id": "abc123", - "id": 987, - "is_default": false, - "name": "abc123", - "sort_order": 123 -} -``` - - - -### WishListUserInputError - -An error encountered while performing operations with WishList. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" -} -``` - - - -### WishListUserInputErrorType - -A list of possible error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `UNDEFINED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### Wishlist - -Contains a customer wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | -| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. | -| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | -| `name` - [`String`](#string) | The name of the wish list. | -| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | - -#### Example - -```json -{ - "id": 4, - "items": [WishlistItem], - "items_count": 123, - "items_v2": WishlistItems, - "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "xyz789", - "visibility": "PUBLIC" -} -``` - - - -### WishlistCartUserInputError - -Contains details about errors encountered when a customer added wish list items to the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](#string) | A localized error message. | -| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "wishlistId": 4, - "wishlistItemId": "4" -} -``` - - - -### WishlistCartUserInputErrorType - -A list of possible error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### WishlistItem - -Contains details about a wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](#string) | The customer's comment about this item. | -| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](#float) | The quantity of this wish list item | - -#### Example - -```json -{ - "added_at": "abc123", - "description": "abc123", - "id": 987, - "product": ProductInterface, - "qty": 123.45 -} -``` - - - -### WishlistItemCopyInput - -Specifies the IDs of items to copy and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | - -#### Example - -```json -{"quantity": 123.45, "wishlist_item_id": 4} -``` - - - -### WishlistItemInput - -Defines the items to add to a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 987.65, - "selected_options": ["4"], - "sku": "abc123" -} -``` - - - -### WishlistItemInterface - -The interface for wish list items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Possible Types - -| WishlistItemInterface Types | -|----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | -| [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### WishlistItemMoveInput - -Specifies the IDs of the items to move and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | - -#### Example - -```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} -``` - - - -### WishlistItemUpdateInput - -Defines updates to items in a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | - -#### Example - -```json -{ - "description": "xyz789", - "entered_options": [EnteredOptionInput], - "quantity": 123.45, - "selected_options": [4], - "wishlist_item_id": 4 -} -``` - - - -### WishlistItems - -Contains an array of items in a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | - -#### Example - -```json -{ - "items": [WishlistItemInterface], - "page_info": SearchResultPageInfo -} -``` - - - -### WishlistOutput - -Deprecated: Use the `Wishlist` type instead. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | -| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | - -#### Example - -```json -{ - "items": [WishlistItem], - "items_count": 123, - "name": "abc123", - "sharing_code": "abc123", - "updated_at": "xyz789" -} -``` - - - -### WishlistVisibilityEnum - -Defines the wish list visibility types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PUBLIC` | | -| `PRIVATE` | | - -#### Example - -```json -""PUBLIC"" -``` - - - -### createEmptyCartInput - -Assigns a specific `cart_id` to the empty cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-a-b.md new file mode 100644 index 000000000..843aaba79 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-a-b.md @@ -0,0 +1,2365 @@ +## Types + +### AcceptNegotiableQuoteTemplateInput + +Specifies the quote template id to accept quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": "4"} +``` + + + +### AddBundleProductsToCartInput + +Defines the bundle products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [BundleProductCartItemInput] +} +``` + + + +### AddBundleProductsToCartOutput + +Contains details about the cart after adding bundle products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddConfigurableProductsToCartInput + +Defines the configurable products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [ConfigurableProductCartItemInput] +} +``` + + + +### AddConfigurableProductsToCartOutput + +Contains details about the cart after adding configurable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddDownloadableProductsToCartInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [DownloadableProductCartItemInput] +} +``` + + + +### AddDownloadableProductsToCartOutput + +Contains details about the cart after adding downloadable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddGiftRegistryRegistrantInput + +Defines a new registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](#string) | The email address of the registrant. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### AddGiftRegistryRegistrantsOutput + +Contains the results of a request to add registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### AddProductsToCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [CartUserInputError] +} +``` + + + +### AddProductsToCompareListInput + +Contains products to add to an existing compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": [4], "uid": 4} +``` + + + +### AddProductsToRequisitionListOutput + +Output of the request to add products to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### AddProductsToWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### AddPurchaseOrderCommentInput + +Contains the comment to be added to a purchase order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | + +#### Example + +```json +{ + "comment": "abc123", + "purchase_order_uid": "4" +} +``` + + + +### AddPurchaseOrderCommentOutput + +Contains the successfully added comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | + +#### Example + +```json +{"comment": PurchaseOrderComment} +``` + + + +### AddPurchaseOrderItemsToCartInput + +Defines the purchase order and cart to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | + +#### Example + +```json +{ + "cart_id": "abc123", + "purchase_order_uid": 4, + "replace_existing_cart_items": true +} +``` + + + +### AddRequisitionListItemToCartUserError + +Contains details about why an attempt to add items to the requistion list failed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | A description of the error. | +| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | + +#### Example + +```json +{ + "message": "abc123", + "type": "OUT_OF_STOCK" +} +``` + + + +### AddRequisitionListItemToCartUserErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OUT_OF_STOCK` | | +| `UNAVAILABLE_SKU` | | +| `OPTIONS_UPDATED` | | +| `LOW_QUANTITY` | | + +#### Example + +```json +""OUT_OF_STOCK"" +``` + + + +### AddRequisitionListItemsToCartOutput + +Output of the request to add items in a requisition list to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | +| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | + +#### Example + +```json +{ + "add_requisition_list_items_to_cart_user_errors": [ + AddRequisitionListItemToCartUserError + ], + "cart": Cart, + "status": false +} +``` + + + +### AddReturnCommentInput + +Defines a return comment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String!`](#string) | The text added to the return request. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{"comment_text": "abc123", "return_uid": 4} +``` + + + +### AddReturnCommentOutput + +Contains details about the return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | The modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### AddReturnTrackingInput + +Defines tracking information to be added to the return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | + +#### Example + +```json +{ + "carrier_uid": 4, + "return_uid": "4", + "tracking_number": "xyz789" +} +``` + + + +### AddReturnTrackingOutput + +Contains the response after adding tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | + +#### Example + +```json +{ + "return": Return, + "return_shipping_tracking": ReturnShippingTracking +} +``` + + + +### AddSimpleProductsToCartInput + +Defines the simple and group products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [SimpleProductCartItemInput] +} +``` + + + +### AddSimpleProductsToCartOutput + +Contains details about the cart after adding simple or group products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddVirtualProductsToCartInput + +Defines the virtual products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [VirtualProductCartItemInput] +} +``` + + + +### AddVirtualProductsToCartOutput + +Contains details about the cart after adding virtual products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddWishlistItemsToCartOutput + +Contains the resultant wish list and any error information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "add_wishlist_items_to_cart_user_errors": [ + WishlistCartUserInputError + ], + "status": false, + "wishlist": Wishlist +} +``` + + + +### Aggregation + +Contains information for each filterable option (such as price, category `UID`, and custom attributes). + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](#int) | The number of options in the aggregation group. | +| `label` - [`String`](#string) | The aggregation display name. | +| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | +| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "count": 987, + "label": "abc123", + "options": [AggregationOption], + "position": 987 +} +``` + + + +### AggregationOption + +An implementation of `AggregationOptionInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Example + +```json +{ + "count": 123, + "label": "abc123", + "value": "xyz789" +} +``` + + + +### AggregationOptionInterface + +Defines aggregation option fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Possible Types + +| AggregationOptionInterface Types | +|----------------| +| [`AggregationOption`](#aggregationoption) | + +#### Example + +```json +{ + "count": 123, + "label": "xyz789", + "value": "abc123" +} +``` + + + +### AggregationsCategoryFilterInput + +Filter category aggregations in layered navigation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | + +#### Example + +```json +{"includeDirectChildrenOnly": false} +``` + + + +### AggregationsFilterInput + +An input object that specifies the filters used in product aggregations. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | + +#### Example + +```json +{"category": AggregationsCategoryFilterInput} +``` + + + +### ApplePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": ButtonStyles, + "code": "abc123", + "is_visible": false, + "payment_intent": "xyz789", + "payment_source": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "xyz789" +} +``` + + + +### ApplePayMethodInput + +Apple Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" +} +``` + + + +### AppliedCoupon + +Contains the applied coupon code. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | + +#### Example + +```json +{"code": "xyz789"} +``` + + + +### AppliedGiftCard + +Contains an applied gift card with applied and remaining balance. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | +| `code` - [`String`](#string) | The gift card account code. | +| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "abc123", + "current_balance": Money, + "expiration_date": "abc123" +} +``` + + + +### AppliedStoreCredit + +Contains the applied and current balances. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | + +#### Example + +```json +{ + "applied_balance": Money, + "current_balance": Money, + "enabled": true +} +``` + + + +### ApplyCouponToCartInput + +Specifies the coupon code to apply to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](#string) | A valid coupon code. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "coupon_code": "abc123" +} +``` + + + +### ApplyCouponToCartOutput + +Contains details about the cart after applying a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyCouponsStrategy + +The strategy to apply coupons to the cart. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""APPEND"" +``` + + + +### ApplyCouponsToCartInput + +Apply coupons to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "coupon_codes": ["xyz789"], + "type": "APPEND" +} +``` + + + +### ApplyGiftCardToCartInput + +Defines the input required to run the `applyGiftCardToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_card_code": "xyz789" +} +``` + + + +### ApplyGiftCardToCartOutput + +Defines the possible output for the `applyGiftCardToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyRewardPointsToCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyStoreCreditToCartInput + +Defines the input required to run the `applyStoreCreditToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### ApplyStoreCreditToCartOutput + +Defines the possible output for the `applyStoreCreditToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AreaInput + +AreaInput defines the parameters which will be used for filter by specified location. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `radius` - [`Int!`](#int) | The radius for the search in KM. | +| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | + +#### Example + +```json +{"radius": 123, "search_term": "abc123"} +``` + + + +### AssignCompareListToCustomerOutput + +Contains the results of the request to assign a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | + +#### Example + +```json +{"compare_list": CompareList, "result": true} +``` + + + +### Attribute + +Contains details about the attribute, including the code and type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | +| `attribute_type` - [`String`](#string) | The data type of the attribute. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "attribute_options": [AttributeOption], + "attribute_type": "xyz789", + "entity_type": "xyz789", + "input_type": "xyz789", + "storefront_properties": StorefrontProperties +} +``` + + + +### AttributeEntityTypeEnum + +List of all entity types. Populated by the modules introducing EAV entities. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CATALOG_PRODUCT` | | +| `CATALOG_CATEGORY` | | +| `CUSTOMER` | | +| `CUSTOMER_ADDRESS` | | +| `RMA_ITEM` | | + +#### Example + +```json +""CATALOG_PRODUCT"" +``` + + + +### AttributeFilterInput + +An input object that specifies the filters used for attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | + +#### Example + +```json +{ + "is_comparable": true, + "is_filterable": false, + "is_filterable_in_search": true, + "is_html_allowed_on_front": true, + "is_searchable": true, + "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_on_front": true, + "is_wysiwyg_enabled": false, + "used_in_product_listing": true +} +``` + + + +### AttributeFrontendInputEnum + +EAV attribute frontend input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `WEIGHT` | | +| `UNDEFINED` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### AttributeInput + +Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "entity_type": "xyz789" +} +``` + + + +### AttributeInputSelectedOption + +Specifies selected option for a select or multiselect attribute value. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### AttributeMetadata + +Base EAV implementation of CustomAttributeMetadataInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | + +#### Example + +```json +{ + "code": "4", + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "abc123", + "frontend_input": "BOOLEAN", + "is_required": true, + "is_unique": false, + "label": "xyz789", + "options": [CustomAttributeOptionInterface] +} +``` + + + +### AttributeMetadataError + +Attribute metadata retrieval error. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | + +#### Example + +```json +{ + "message": "xyz789", + "type": "ENTITY_NOT_FOUND" +} +``` + + + +### AttributeMetadataErrorType + +Attribute metadata retrieval error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ENTITY_NOT_FOUND"" +``` + + + +### AttributeOption + +Defines an attribute option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label assigned to the attribute option. | +| `value` - [`String`](#string) | The attribute option value. | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### AttributeOptionMetadata + +Base EAV implementation of CustomAttributeOptionInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{ + "is_default": false, + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOption + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOptionInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Possible Types + +| AttributeSelectedOptionInterface Types | +|----------------| +| [`AttributeSelectedOption`](#attributeselectedoption) | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### AttributeSelectedOptions + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | + +#### Example + +```json +{ + "code": "4", + "selected_options": [AttributeSelectedOptionInterface] +} +``` + + + +### AttributeValue + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `value` - [`String!`](#string) | The attribute value. | + +#### Example + +```json +{ + "code": "4", + "value": "xyz789" +} +``` + + + +### AttributeValueInput + +Specifies the value for attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | +| `value` - [`String`](#string) | The value assigned to the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "selected_options": [AttributeInputSelectedOption], + "value": "abc123" +} +``` + + + +### AttributeValueInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | + +#### Possible Types + +| AttributeValueInterface Types | +|----------------| +| [`AttributeValue`](#attributevalue) | +| [`AttributeSelectedOptions`](#attributeselectedoptions) | + +#### Example + +```json +{"code": 4} +``` + + + +### AttributesFormOutput + +Metadata of EAV attributes associated to form + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AttributesMetadataOutput + +Metadata of EAV attributes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AvailableCurrency + +Defines the code and symbol of a currency that can be used for purchase orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](#string) | Currency symbol, for example $. | + +#### Example + +```json +{"code": "AFN", "symbol": "xyz789"} +``` + + + +### AvailablePaymentMethod + +Describes a payment method that the shopper can use to pay for the order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "xyz789", + "is_deferred": true, + "title": "xyz789" +} +``` + + + +### AvailableShippingMethod + +Contains details about the possible shipping methods and carriers. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `error_message` - [`String`](#string) | Describes an error condition. | +| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "available": true, + "base_amount": Money, + "carrier_code": "xyz789", + "carrier_title": "abc123", + "error_message": "abc123", + "method_code": "xyz789", + "method_title": "abc123", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### BatchMutationStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUCCESS` | | +| `FAILURE` | | +| `MIXED_RESULTS` | | + +#### Example + +```json +""SUCCESS"" +``` + + + +### BillingAddressInput + +Defines the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | +| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 123, + "same_as_shipping": true, + "use_for_shipping": true +} +``` + + + +### BillingCartAddress + +Contains details about the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "city": "xyz789", + "company": "abc123", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "xyz789", + "region": CartAddressRegion, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "abc123", + "uid": "abc123", + "vat_id": "abc123" +} +``` + + + +### Boolean + +The `Boolean` scalar type represents `true` or `false`. + +#### Example + +```json +true +``` + + + +### BraintreeCcVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "xyz789", + "public_hash": "xyz789" +} +``` + + + +### BraintreeInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#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!`](#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!`](#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | + +#### Example + +```json +{ + "device_data": "abc123", + "is_active_payment_token_enabler": false, + "payment_method_nonce": "abc123" +} +``` + + + +### BraintreeVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "xyz789", + "public_hash": "xyz789" +} +``` + + + +### Breadcrumb + +Contains details about an individual category that comprises a breadcrumb. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](#int) | The category level. | +| `category_name` - [`String`](#string) | The display name of the category. | +| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](#string) | The URL key of the category. | +| `category_url_path` - [`String`](#string) | The URL path of the category. | + +#### Example + +```json +{ + "category_id": 987, + "category_level": 123, + "category_name": "abc123", + "category_uid": "4", + "category_url_key": "abc123", + "category_url_path": "abc123" +} +``` + + + +### BundleCartItem + +An implementation for bundle product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "available_gift_wrapping": [GiftWrapping], + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "abc123", + "is_available": true, + "max_qty": 123.45, + "min_qty": 987.65, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleCreditMemoItem + +Defines bundle product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 123.45 +} +``` + + + +### BundleInvoiceItem + +Defines bundle product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### BundleItem + +Defines an individual item within a bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | +| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | +| `sku` - [`String`](#string) | The SKU of the bundle product. | +| `title` - [`String`](#string) | The display name of the item. | +| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | + +#### Example + +```json +{ + "option_id": 123, + "options": [BundleItemOption], + "position": 987, + "price_range": PriceRange, + "required": false, + "sku": "abc123", + "title": "xyz789", + "type": "xyz789", + "uid": "4" +} +``` + + + +### BundleItemOption + +Defines the characteristics that comprise a specific bundle item and its options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | +| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | +| `label` - [`String`](#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | + +#### Example + +```json +{ + "can_change_quantity": false, + "id": 987, + "is_default": false, + "label": "xyz789", + "position": 123, + "price": 123.45, + "price_type": "FIXED", + "product": ProductInterface, + "qty": 987.65, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleOptionInput + +Defines the input for a bundle option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`Int!`](#int) | The ID of the option. | +| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | + +#### Example + +```json +{ + "id": 987, + "quantity": 123.45, + "value": ["xyz789"] +} +``` + + + +### BundleOrderItem + +Defines bundle product options for `OrderItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "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": 123.45, + "quantity_refunded": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "abc123" +} +``` + + + +### BundleProduct + +Defines basic features of a bundle product and contains multiple BundleItems. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | +| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | +| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "xyz789", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "dynamic_price": false, + "dynamic_sku": false, + "dynamic_weight": true, + "gift_message_available": "xyz789", + "id": 123, + "image": ProductImage, + "is_returnable": "abc123", + "items": [BundleItem], + "manufacturer": 987, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "abc123", + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price": ProductPrices, + "price_details": PriceDetails, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "price_view": "PRICE_RANGE", + "product_links": [ProductLinksInterface], + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "ship_bundle_items": "TOGETHER", + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "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": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 123.45 +} +``` + + + +### BundleProductCartItemInput + +Defines a single bundle product. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | + +#### Example + +```json +{ + "bundle_options": [BundleOptionInput], + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### BundleRequisitionListItem + +Contains details about bundle products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | + +#### Example + +```json +{ + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### BundleShipmentItem + +Defines bundle product options for `ShipmentItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### BundleWishlistItem + +Defines bundle product options for `WishlistItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### ButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `label` - [`String`](#string) | The button label | +| `layout` - [`String`](#string) | The button layout | +| `shape` - [`String`](#string) | The button shape | +| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | +| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | + +#### Example + +```json +{ + "color": "abc123", + "height": 987, + "label": "abc123", + "layout": "xyz789", + "shape": "abc123", + "tagline": false, + "use_default_height": false +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-1.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md similarity index 67% rename from src/pages/includes/autogenerated/graphql-api-2-4-7-types-1.md rename to src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md index 56d02c7e2..5f077a9c4 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-1.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-c-e.md @@ -1,6812 +1,7031 @@ ## Types -### AcceptNegotiableQuoteTemplateInput +### CancelNegotiableQuoteTemplateInput -Specifies the quote template id to accept quote template. +Specifies the quote template id of the quote template to cancel #### Input Fields | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{ + "cancellation_comment": "xyz789", + "template_id": "4" +} ``` -### AddBundleProductsToCartInput +### CancelOrderInput -Defines the bundle products to add to the cart. +Defines the order to cancel. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | +| `order_id` - [`ID!`](#id) | Order ID. | +| `reason` - [`String!`](#string) | Cancellation reason. | #### Example ```json -{ - "cart_id": "abc123", - "cart_items": [BundleProductCartItemInput] -} +{"order_id": 4, "reason": "abc123"} ``` -### AddBundleProductsToCartOutput +### CancelOrderOutput -Contains details about the cart after adding bundle products. +Contains the updated customer order and error message if any. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddConfigurableProductsToCartInput - -Defines the configurable products to add to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [ConfigurableProductCartItemInput] + "error": "xyz789", + "order": CustomerOrder } ``` -### AddConfigurableProductsToCartOutput - -Contains details about the cart after adding configurable products. +### CancellationReason #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `description` - [`String!`](#string) | | #### Example ```json -{"cart": Cart} +{"description": "abc123"} ``` -### AddDownloadableProductsToCartInput +### Card -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| Field Name | Description | +|------------|-------------| +| `bin_details` - [`CardBin`](#cardbin) | Card bin details | +| `card_expiry_month` - [`String`](#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](#string) | Expiration year of the card | +| `last_digits` - [`String`](#string) | Last four digits of the card | +| `name` - [`String`](#string) | Name on the card | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [DownloadableProductCartItemInput] + "bin_details": CardBin, + "card_expiry_month": "xyz789", + "card_expiry_year": "xyz789", + "last_digits": "xyz789", + "name": "abc123" } ``` -### AddDownloadableProductsToCartOutput - -Contains details about the cart after adding downloadable products. +### CardBin #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddGiftRegistryRegistrantInput - -Defines a new registrant. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](#string) | The email address of the registrant. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `bin` - [`String`](#string) | Card bin number | #### Example ```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "abc123", - "firstname": "xyz789", - "lastname": "xyz789" -} +{"bin": "abc123"} ``` -### AddGiftRegistryRegistrantsOutput +### Cart -Contains the results of a request to add registrants. +Contains the contents and other details about a guest or customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. *(Deprecated: Use `itemsV2` instead.)* | +| `itemsV2` - [`CartItems`](#cartitems) | | +| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "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": true, + "items": [CartItemInterface], + "itemsV2": CartItems, + "prices": CartPrices, + "printed_card_included": false, + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [ShippingCartAddress], + "total_quantity": 987.65 +} ``` -### AddProductsToCartOutput +### CartAddressCountry -Contains details about the cart after adding products to it. +Contains details the country in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `code` - [`String!`](#string) | The country code. | +| `label` - [`String!`](#string) | The display label for the country. | #### Example ```json { - "cart": Cart, - "user_errors": [CartUserInputError] + "code": "xyz789", + "label": "abc123" } ``` -### AddProductsToCompareListInput +### CartAddressInput -Contains products to add to an existing compare list. +Defines the billing or shipping address to be applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example ```json -{"products": [4], "uid": "4"} +{ + "city": "abc123", + "company": "abc123", + "country_code": "abc123", + "custom_attributes": [AttributeValueInput], + "fax": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": "xyz789", + "region_id": 987, + "save_in_address_book": false, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "xyz789" +} ``` -### AddProductsToRequisitionListOutput - -Output of the request to add products to a requisition list. +### CartAddressInterface #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### AddProductsToWishlistOutput - -Contains the customer's wish list and any errors encountered. +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | -#### Fields +#### Possible Types -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| CartAddressInterface Types | +|----------------| +| [`ShippingCartAddress`](#shippingcartaddress) | +| [`BillingCartAddress`](#billingcartaddress) | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "city": "abc123", + "company": "xyz789", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "fax": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CartAddressRegion, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "abc123", + "vat_id": "abc123" } ``` -### AddPurchaseOrderCommentInput +### CartAddressRegion -Contains the comment to be added to a purchase order. +Contains details about the region in a billing or shipping address. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The state or province code. | +| `label` - [`String`](#string) | The display label for the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "comment": "xyz789", - "purchase_order_uid": 4 + "code": "abc123", + "label": "xyz789", + "region_id": 987 } ``` -### AddPurchaseOrderCommentOutput +### CartDiscount -Contains the successfully added comment. +Contains information about discounts applied to the cart. #### Fields | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | +| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](#string) | The description of the discount. | #### Example ```json -{"comment": PurchaseOrderComment} +{ + "amount": Money, + "label": ["abc123"] +} ``` -### AddPurchaseOrderItemsToCartInput - -Defines the purchase order and cart to act on. +### CartDiscountType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | -| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | +| Enum Value | Description | +|------------|-------------| +| `ITEM` | | +| `SHIPPING` | | #### Example ```json -{ - "cart_id": "abc123", - "purchase_order_uid": "4", - "replace_existing_cart_items": false -} +""ITEM"" ``` -### AddRequisitionListItemToCartUserError - -Contains details about why an attempt to add items to the requistion list failed. +### CartItemError #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | -| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | +| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | +| `message` - [`String!`](#string) | A localized error message | #### Example ```json -{ - "message": "abc123", - "type": "OUT_OF_STOCK" -} +{"code": "UNDEFINED", "message": "xyz789"} ``` -### AddRequisitionListItemToCartUserErrorType +### CartItemErrorType #### Values | Enum Value | Description | |------------|-------------| -| `OUT_OF_STOCK` | | -| `UNAVAILABLE_SKU` | | -| `OPTIONS_UPDATED` | | -| `LOW_QUANTITY` | | +| `UNDEFINED` | | +| `ITEM_QTY` | | +| `ITEM_INCREMENTS` | | #### Example ```json -""OUT_OF_STOCK"" +""UNDEFINED"" ``` -### AddRequisitionListItemsToCartOutput +### CartItemInput -Output of the request to add items in a requisition list to the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | -| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | - -#### Example - -```json -{ - "add_requisition_list_items_to_cart_user_errors": [ - AddRequisitionListItemToCartUserError - ], - "cart": Cart, - "status": true -} -``` - - - -### AddReturnCommentInput - -Defines a return comment. +Defines an item to be added to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](#string) | The text added to the return request. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | +| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | #### Example ```json { - "comment_text": "xyz789", - "return_uid": "4" + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 987.65, + "selected_options": [4], + "sku": "xyz789" } ``` -### AddReturnCommentOutput +### CartItemInterface -Contains details about the return request. +An interface for products in a cart. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | - -#### Example - -```json -{"return": Return} -``` - - - -### AddReturnTrackingInput - -Defines tracking information to be added to the return. +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | +| CartItemInterface Types | +|----------------| +| [`SimpleCartItem`](#simplecartitem) | +| [`VirtualCartItem`](#virtualcartitem) | +| [`ConfigurableCartItem`](#configurablecartitem) | +| [`DownloadableCartItem`](#downloadablecartitem) | +| [`BundleCartItem`](#bundlecartitem) | +| [`GiftCardCartItem`](#giftcardcartitem) | #### Example ```json { - "carrier_uid": "4", - "return_uid": 4, - "tracking_number": "xyz789" + "discount": [Discount], + "errors": [CartItemError], + "id": "abc123", + "is_available": false, + "max_qty": 123.45, + "min_qty": 987.65, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 } ``` -### AddReturnTrackingOutput +### CartItemPrices -Contains the response after adding tracking information. +Contains details about the price of the item, including taxes and discounts. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | +| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | #### Example ```json { - "return": Return, - "return_shipping_tracking": ReturnShippingTracking + "discounts": [Discount], + "fixed_product_taxes": [FixedProductTax], + "price": Money, + "price_including_tax": Money, + "row_total": Money, + "row_total_including_tax": Money, + "total_item_discount": Money } ``` -### AddSimpleProductsToCartInput +### CartItemQuantity -Defines the simple and group products to add to the cart. +Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | +| Field Name | Description | +|------------|-------------| +| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{ - "cart_id": "abc123", - "cart_items": [SimpleProductCartItemInput] -} +{"cart_item_id": 123, "quantity": 987.65} ``` -### AddSimpleProductsToCartOutput +### CartItemSelectedOptionValuePrice -Contains details about the cart after adding simple or group products. +Contains details about the price of a selected customizable value. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](#float) | A price value. | #### Example ```json -{"cart": Cart} +{ + "type": "FIXED", + "units": "xyz789", + "value": 987.65 +} ``` -### AddVirtualProductsToCartInput +### CartItemUpdateInput -Defines the virtual products to add to the cart. +A single item to be updated. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [VirtualProductCartItemInput] + "cart_item_id": 987, + "cart_item_uid": "4", + "customizable_options": [CustomizableOptionInput], + "gift_message": GiftMessageInput, + "gift_wrapping_id": 4, + "quantity": 123.45 } ``` -### AddVirtualProductsToCartOutput - -Contains details about the cart after adding virtual products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddWishlistItemsToCartOutput - -Contains the resultant wish list and any error information. +### CartItems #### Fields | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned cart items. | #### Example ```json { - "add_wishlist_items_to_cart_user_errors": [ - WishlistCartUserInputError - ], - "status": true, - "wishlist": Wishlist + "items": [CartItemInterface], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### Aggregation +### CartPrices -Contains information for each filterable option (such as price, category `UID`, and custom attributes). +Contains details about the final price of items in the cart, including discount and tax information. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](#int) | The number of options in the aggregation group. | -| `label` - [`String`](#string) | The aggregation display name. | -| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | +| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | +| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | +| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | +| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | #### Example ```json { - "attribute_code": "xyz789", - "count": 987, - "label": "xyz789", - "options": [AggregationOption], - "position": 123 + "applied_taxes": [CartTaxItem], + "discount": CartDiscount, + "discounts": [Discount], + "gift_options": GiftOptionsPrices, + "grand_total": Money, + "subtotal_excluding_tax": Money, + "subtotal_including_tax": Money, + "subtotal_with_discount_excluding_tax": Money } ``` -### AggregationOption +### CartTaxItem -An implementation of `AggregationOptionInterface`. +Contains tax information about an item in the cart. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `label` - [`String!`](#string) | The description of the tax. | #### Example ```json { - "count": 987, - "label": "xyz789", - "value": "xyz789" + "amount": Money, + "label": "abc123" } ``` -### AggregationOptionInterface +### CartUserInputError -Defines aggregation option fields. +An error encountered while adding an item to the the cart. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | - -#### Possible Types - -| AggregationOptionInterface Types | -|----------------| -| [`AggregationOption`](#aggregationoption) | +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "count": 987, - "label": "abc123", - "value": "xyz789" + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" } ``` -### AggregationsCategoryFilterInput - -Filter category aggregations in layered navigation. +### CartUserInputErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | +| `PERMISSION_DENIED` | | #### Example ```json -{"includeDirectChildrenOnly": false} +""PRODUCT_NOT_FOUND"" ``` -### AggregationsFilterInput - -An input object that specifies the filters used in product aggregations. +### CatalogAttributeApplyToEnum -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | +| Enum Value | Description | +|------------|-------------| +| `SIMPLE` | | +| `VIRTUAL` | | +| `BUNDLE` | | +| `DOWNLOADABLE` | | +| `CONFIGURABLE` | | +| `GROUPED` | | +| `CATEGORY` | | #### Example ```json -{"category": AggregationsCategoryFilterInput} +""SIMPLE"" ``` -### ApplePayConfig +### CatalogAttributeMetadata + +Swatch attribute metadata. #### Fields | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | +| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example ```json { - "button_styles": ButtonStyles, - "code": "abc123", - "is_visible": false, - "payment_intent": "abc123", - "payment_source": "abc123", - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "abc123" + "apply_to": ["SIMPLE"], + "code": 4, + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "abc123", + "frontend_input": "BOOLEAN", + "is_comparable": true, + "is_filterable": false, + "is_filterable_in_search": true, + "is_html_allowed_on_front": false, + "is_required": false, + "is_searchable": false, + "is_unique": true, + "is_used_for_price_rules": true, + "is_used_for_promo_rules": false, + "is_visible_in_advanced_search": false, + "is_visible_on_front": true, + "is_wysiwyg_enabled": true, + "label": "abc123", + "options": [CustomAttributeOptionInterface], + "swatch_input_type": "BOOLEAN", + "update_product_preview_image": false, + "use_product_image_for_swatch": true, + "used_in_product_listing": true } ``` -### ApplePayMethodInput +### CategoryFilterInput -Apple Pay inputs +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | + #### Example ```json { - "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "category_uid": FilterEqualTypeInput, + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput, + "parent_category_uid": FilterEqualTypeInput, + "parent_id": FilterEqualTypeInput, + "url_key": FilterEqualTypeInput, + "url_path": FilterEqualTypeInput } ``` -### AppliedCoupon +### CategoryInterface -Contains the applied coupon code. +Contains the full set of attributes that can be returned in a category search. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | + +#### Possible Types + +| CategoryInterface Types | +|----------------| +| [`CategoryTree`](#categorytree) | #### Example ```json -{"code": "abc123"} +{ + "automatic_sorting": "xyz789", + "available_sort_by": ["xyz789"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "abc123", + "children_count": "abc123", + "cms_block": CmsBlock, + "created_at": "abc123", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", + "description": "abc123", + "display_mode": "abc123", + "filter_price_range": 987.65, + "id": 987, + "image": "xyz789", + "include_in_menu": 123, + "is_anchor": 123, + "landing_page": 987, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "abc123", + "meta_title": "abc123", + "name": "abc123", + "path": "xyz789", + "path_in_store": "xyz789", + "position": 987, + "product_count": 123, + "products": CategoryProducts, + "staged": false, + "uid": 4, + "updated_at": "abc123", + "url_key": "abc123", + "url_path": "xyz789", + "url_suffix": "xyz789" +} ``` -### AppliedGiftCard +### CategoryProducts -Contains an applied gift card with applied and remaining balance. +Contains details about the products assigned to a category. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | -| `code` - [`String`](#string) | The gift card account code. | -| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#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 ```json { - "applied_balance": Money, - "code": "abc123", - "current_balance": Money, - "expiration_date": "xyz789" + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### AppliedStoreCredit +### CategoryResult -Contains the applied and current balances. +Contains a collection of `CategoryTree` objects and pagination information. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | +| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | #### Example ```json { - "applied_balance": Money, - "current_balance": Money, - "enabled": false + "items": [CategoryTree], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### ApplyCouponToCartInput +### CategoryTree -Specifies the coupon code to apply to the cart. +Contains the hierarchy of categories. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| Field Name | Description | +|------------|-------------| +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | +| `children_count` - [`String`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "cart_id": "xyz789", - "coupon_code": "xyz789" + "automatic_sorting": "xyz789", + "available_sort_by": ["abc123"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "abc123", + "children": [CategoryTree], + "children_count": "xyz789", + "cms_block": CmsBlock, + "created_at": "xyz789", + "custom_layout_update_file": "xyz789", + "default_sort_by": "xyz789", + "description": "abc123", + "display_mode": "xyz789", + "filter_price_range": 987.65, + "id": 123, + "image": "xyz789", + "include_in_menu": 123, + "is_anchor": 123, + "landing_page": 987, + "level": 987, + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "name": "abc123", + "path": "xyz789", + "path_in_store": "xyz789", + "position": 987, + "product_count": 987, + "products": CategoryProducts, + "redirect_code": 123, + "relative_url": "xyz789", + "staged": true, + "type": "CMS_PAGE", + "uid": "4", + "updated_at": "xyz789", + "url_key": "xyz789", + "url_path": "xyz789", + "url_suffix": "abc123" } ``` -### ApplyCouponToCartOutput +### CheckoutAgreement -Contains details about the cart after applying a coupon. +Defines details about an individual checkout agreement. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](#string) | Required. The text of the agreement. | +| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | +| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | +| `name` - [`String!`](#string) | The name given to the condition. | #### Example ```json -{"cart": Cart} +{ + "agreement_id": 987, + "checkbox_text": "abc123", + "content": "xyz789", + "content_height": "abc123", + "is_html": true, + "mode": "AUTO", + "name": "xyz789" +} ``` -### ApplyCouponsStrategy +### CheckoutAgreementMode -The strategy to apply coupons to the cart. +Indicates how agreements are accepted. #### Values | Enum Value | Description | |------------|-------------| -| `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. | +| `AUTO` | Conditions are automatically accepted upon checkout. | +| `MANUAL` | Shoppers must manually accept the conditions to place an order. | #### Example ```json -""APPEND"" +""AUTO"" ``` -### ApplyCouponsToCartInput +### CheckoutUserInputError -Apply coupons to the cart. +An error encountered while adding an item to the cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | -| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | +| `message` - [`String!`](#string) | A localized error message. | +| `path` - [`[String]!`](#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 ```json { - "cart_id": "abc123", - "coupon_codes": ["xyz789"], - "type": "APPEND" + "code": "REORDER_NOT_AVAILABLE", + "message": "xyz789", + "path": ["xyz789"] } ``` -### ApplyGiftCardToCartInput - -Defines the input required to run the `applyGiftCardToCart` mutation. +### CheckoutUserInputErrorCodes -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | +| Enum Value | Description | +|------------|-------------| +| `REORDER_NOT_AVAILABLE` | | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | #### Example ```json -{ - "cart_id": "abc123", - "gift_card_code": "abc123" -} +""REORDER_NOT_AVAILABLE"" ``` -### ApplyGiftCardToCartOutput +### ClearCartError -Defines the possible output for the `applyGiftCardToCart` mutation. +Contains details about errors encountered when a customer clear cart. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `message` - [`String!`](#string) | A localized error message | +| `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{"cart": Cart} +{"message": "xyz789", "type": "NOT_FOUND"} ``` -### ApplyRewardPointsToCartOutput - -Contains the customer cart. +### ClearCartErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `NOT_FOUND` | | +| `UNAUTHORISED` | | +| `INACTIVE` | | +| `UNDEFINED` | | #### Example ```json -{"cart": Cart} +""NOT_FOUND"" ``` -### ApplyStoreCreditToCartInput +### ClearCartInput -Defines the input required to run the `applyStoreCreditToCart` mutation. +Assigns a specific `cart_id` to the empty cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"uid": 4} ``` -### ApplyStoreCreditToCartOutput +### ClearCartOutput -Defines the possible output for the `applyStoreCreditToCart` mutation. +Output of the request to clear the customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart`](#cart) | The cart after clear cart items. | +| `errors` - [`[ClearCartError]`](#clearcarterror) | An array of errors encountered while clearing the cart item | #### Example ```json -{"cart": Cart} +{ + "cart": Cart, + "errors": [ClearCartError] +} ``` -### AreaInput +### ClearCustomerCartOutput -AreaInput defines the parameters which will be used for filter by specified location. +Output of the request to clear the customer cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `radius` - [`Int!`](#int) | The radius for the search in KM. | -| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after clearing items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | #### Example ```json -{"radius": 123, "search_term": "xyz789"} +{"cart": Cart, "status": false} ``` -### AssignCompareListToCustomerOutput - -Contains the results of the request to assign a compare list. +### CloseNegotiableQuoteError -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | #### Example ```json -{"compare_list": CompareList, "result": true} +NegotiableQuoteInvalidStateError ``` -### Attribute +### CloseNegotiableQuoteOperationFailure -Contains details about the attribute, including the code and type. +Contains details about a failed close operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | -| `attribute_type` - [`String`](#string) | The data type of the attribute. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "attribute_code": "xyz789", - "attribute_options": [AttributeOption], - "attribute_type": "xyz789", - "entity_type": "xyz789", - "input_type": "abc123", - "storefront_properties": StorefrontProperties + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": "4" } ``` -### AttributeEntityTypeEnum - -List of all entity types. Populated by the modules introducing EAV entities. +### CloseNegotiableQuoteOperationResult -#### Values +#### Types -| Enum Value | Description | -|------------|-------------| -| `CATALOG_PRODUCT` | | -| `CATALOG_CATEGORY` | | -| `CUSTOMER` | | -| `CUSTOMER_ADDRESS` | | -| `RMA_ITEM` | | +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example ```json -""CATALOG_PRODUCT"" +NegotiableQuoteUidOperationSuccess ``` -### AttributeFilterInput +### CloseNegotiableQuotesInput -An input object that specifies the filters used for attributes. +Defines the negotiable quotes to mark as closed. #### Input Fields | Input Field | Description | |-------------|-------------| -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{ - "is_comparable": false, - "is_filterable": true, - "is_filterable_in_search": false, - "is_html_allowed_on_front": false, - "is_searchable": false, - "is_used_for_customer_segment": false, - "is_used_for_price_rules": false, - "is_used_for_promo_rules": true, - "is_visible_in_advanced_search": true, - "is_visible_on_front": true, - "is_wysiwyg_enabled": true, - "used_in_product_listing": false -} +{"quote_uids": ["4"]} ``` -### AttributeFrontendInputEnum +### CloseNegotiableQuotesOutput -EAV attribute frontend input types. +Contains the closed negotiable quotes and other negotiable quotes the company user can view. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `WEIGHT` | | -| `UNDEFINED` | | +| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example ```json -""BOOLEAN"" +{ + "closed_quotes": [NegotiableQuote], + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" +} ``` -### AttributeInput +### CmsBlock -Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. +Contains details about a specific CMS block. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| Field Name | Description | +|------------|-------------| +| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](#string) | The CMS block identifier. | +| `title` - [`String`](#string) | The title assigned to the CMS block. | #### Example ```json { - "attribute_code": "xyz789", - "entity_type": "xyz789" + "content": "xyz789", + "identifier": "abc123", + "title": "xyz789" } ``` -### AttributeInputSelectedOption +### CmsBlocks -Specifies selected option for a select or multiselect attribute value. +Contains an array CMS block items. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | #### Example ```json -{"value": "xyz789"} +{"items": [CmsBlock]} ``` -### AttributeMetadata +### CmsPage -Base EAV implementation of CustomAttributeMetadataInterface. +Contains details about a CMS page. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](#string) | The ID of a CMS page. | +| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { - "code": 4, - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "is_required": true, - "is_unique": false, - "label": "abc123", - "options": [CustomAttributeOptionInterface] + "content": "abc123", + "content_heading": "abc123", + "identifier": "abc123", + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "page_layout": "abc123", + "redirect_code": 123, + "relative_url": "abc123", + "title": "abc123", + "type": "CMS_PAGE", + "url_key": "abc123" } ``` -### AttributeMetadataError - -Attribute metadata retrieval error. +### ColorSwatchData #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | -| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{ - "message": "abc123", - "type": "ENTITY_NOT_FOUND" -} +{"value": "xyz789"} ``` -### AttributeMetadataErrorType +### CompaniesSortFieldEnum -Attribute metadata retrieval error types. +The fields available for sorting the customer companies. #### Values | Enum Value | Description | |------------|-------------| -| `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. | +| `NAME` | The name of the company. | #### Example ```json -""ENTITY_NOT_FOUND"" +""NAME"" ``` -### AttributeOption +### CompaniesSortInput -Defines an attribute option. +Specifies which field to sort on, and whether to return the results in ascending or descending order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| Input Field | Description | +|-------------|-------------| +| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | +| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example ```json -{ - "label": "xyz789", - "value": "xyz789" -} +{"field": "NAME", "order": "ASC"} ``` -### AttributeOptionMetadata +### Company -Base EAV implementation of CustomAttributeOptionInterface. +Contains the output schema for a company. #### Fields | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | +| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | +| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | +| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | +| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | +| `email` - [`String`](#string) | The email address of the company contact. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | +| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | +| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | +| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | +| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | +| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | +| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "is_default": false, - "label": "xyz789", - "value": "xyz789" + "acl_resources": [CompanyAclResource], + "company_admin": Customer, + "credit": CompanyCredit, + "credit_history": CompanyCreditHistory, + "email": "xyz789", + "id": 4, + "legal_address": CompanyLegalAddress, + "legal_name": "abc123", + "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": "xyz789" } ``` -### AttributeSelectedOption +### CompanyAclResource + +Contains details about the access control list settings of a resource. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | +| `text` - [`String`](#string) | The label assigned to the ACL resource. | #### Example ```json { - "label": "abc123", - "value": "xyz789" + "children": [CompanyAclResource], + "id": 4, + "sort_order": 123, + "text": "xyz789" } ``` -### AttributeSelectedOptionInterface - -#### Fields +### CompanyAdminInput -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +Defines the input schema for creating a company administrator. -#### Possible Types +#### Input Fields -| AttributeSelectedOptionInterface Types | -|----------------| -| [`AttributeSelectedOption`](#attributeselectedoption) | +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the company administrator. | +| `firstname` - [`String!`](#string) | The company administrator's first name. | +| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](#string) | The job title of the company administrator. | +| `lastname` - [`String!`](#string) | The company administrator's last name. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "email": "abc123", + "firstname": "abc123", + "gender": 123, + "job_title": "xyz789", + "lastname": "abc123" } ``` -### AttributeSelectedOptions +### CompanyBasicInfo + +The minimal required information to identify and display the company. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | #### Example ```json { - "code": "4", - "selected_options": [AttributeSelectedOptionInterface] + "id": 4, + "legal_name": "abc123", + "name": "abc123" } ``` -### AttributeValue - -#### Fields +### CompanyCreateInput -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +Defines the input schema for creating a new company. -#### Example - -```json -{ - "code": "4", - "value": "xyz789" -} -``` - - - -### AttributeValueInput - -Specifies the value for attribute. - -#### Input Fields +#### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | -| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](#string) | The value assigned to the attribute. | +| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | +| `company_email` - [`String!`](#string) | The email address of the company contact. | +| `company_name` - [`String!`](#string) | The name of the company to create. | +| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "attribute_code": "abc123", - "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "company_admin": CompanyAdminInput, + "company_email": "xyz789", + "company_name": "xyz789", + "legal_address": CompanyLegalAddressCreateInput, + "legal_name": "abc123", + "reseller_id": "abc123", + "vat_tax_id": "abc123" } ``` -### AttributeValueInterface +### CompanyCredit + +Contains company credit balances and limits. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | - -#### Possible Types - -| AttributeValueInterface Types | -|----------------| -| [`AttributeValue`](#attributevalue) | -| [`AttributeSelectedOptions`](#attributeselectedoptions) | +| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](#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 ```json -{"code": "4"} +{ + "available_credit": Money, + "credit_limit": Money, + "outstanding_balance": Money +} ``` -### AttributesFormOutput +### CompanyCreditHistory -Metadata of EAV attributes associated to form +Contains details about prior company credit operations. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] + "items": [CompanyCreditOperation], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### AttributesMetadataOutput +### CompanyCreditHistoryFilterInput -Metadata of EAV attributes. +Defines a filter for narrowing the results of a credit history search. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| Input Field | Description | +|-------------|-------------| +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] + "custom_reference_number": "abc123", + "operation_type": "ALLOCATION", + "updated_by": "xyz789" } ``` -### AvailableCurrency +### CompanyCreditOperation -Defines the code and symbol of a currency that can be used for purchase orders. +Contains details about a single company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](#string) | The date the operation occurred. | +| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{ + "amount": Money, + "balance": CompanyCredit, + "custom_reference_number": "xyz789", + "date": "xyz789", + "type": "ALLOCATION", + "updated_by": CompanyCreditOperationUser +} ``` -### AvailablePaymentMethod - -Describes a payment method that the shopper can use to pay for the order. +### CompanyCreditOperationType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `ALLOCATION` | | +| `UPDATE` | | +| `PURCHASE` | | +| `REIMBURSEMENT` | | +| `REFUND` | | +| `REVERT` | | #### Example ```json -{ - "code": "abc123", - "is_deferred": false, - "title": "xyz789" -} +""ALLOCATION"" ``` -### AvailableShippingMethod +### CompanyCreditOperationUser -Contains details about the possible shipping methods and carriers. +Defines the administrator or company user that submitted a company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `error_message` - [`String`](#string) | Describes an error condition. | -| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | #### Example ```json -{ - "amount": Money, - "available": false, - "base_amount": Money, - "carrier_code": "xyz789", - "carrier_title": "xyz789", - "error_message": "xyz789", - "method_code": "abc123", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money -} +{"name": "xyz789", "type": "CUSTOMER"} ``` -### BatchMutationStatus +### CompanyCreditOperationUserType #### Values | Enum Value | Description | |------------|-------------| -| `SUCCESS` | | -| `FAILURE` | | -| `MIXED_RESULTS` | | +| `CUSTOMER` | | +| `ADMIN` | | #### Example ```json -""SUCCESS"" +""CUSTOMER"" ``` -### BillingAddressInput +### CompanyInvitationInput -Defines the billing address. +Defines the input schema for accepting the company invitation. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | -| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `code` - [`String!`](#string) | The invitation code. | +| `role_id` - [`ID`](#id) | The company role id. | +| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "address": CartAddressInput, - "customer_address_id": 987, - "same_as_shipping": false, - "use_for_shipping": false + "code": "xyz789", + "role_id": 4, + "user": CompanyInvitationUserInput } ``` -### BillingCartAddress +### CompanyInvitationOutput -Contains details about the billing address. +The result of accepting the company invitation. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | #### Example ```json -{ - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_notes": "abc123", - "fax": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", - "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "xyz789", - "vat_id": "xyz789" -} +{"success": true} ``` -### Boolean - -The `Boolean` scalar type represents `true` or `false`. - -#### Example - -```json -true -``` - - +### CompanyInvitationUserInput -### BraintreeCcVaultInput +Company user attributes in the invitation. #### Input Fields | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `company_id` - [`ID!`](#id) | The company unique identifier. | +| `customer_id` - [`ID!`](#id) | The customer unique identifier. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The phone number of the company user. | #### Example ```json { - "device_data": "abc123", - "public_hash": "xyz789" + "company_id": 4, + "customer_id": "4", + "job_title": "xyz789", + "status": "ACTIVE", + "telephone": "abc123" } ``` -### BraintreeInput +### CompanyLegalAddress -#### Input Fields +Contains details about the address where the company is registered to conduct business. -| Input Field | Description | -|-------------|-------------| -| `device_data` - [`String`](#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!`](#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!`](#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | +| `postcode` - [`String`](#string) | The company's postal code. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | +| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](#string) | The company's phone number. | #### Example ```json { - "device_data": "abc123", - "is_active_payment_token_enabler": true, - "payment_method_nonce": "abc123" + "city": "abc123", + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegion, + "street": ["abc123"], + "telephone": "abc123" } ``` -### BraintreeVaultInput +### CompanyLegalAddressCreateInput + +Defines the input schema for defining a company's legal address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | +| `postcode` - [`String!`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](#string) | The primary phone number of the company. | #### Example ```json { - "device_data": "abc123", - "public_hash": "abc123" + "city": "xyz789", + "country_id": "AF", + "postcode": "abc123", + "region": CustomerAddressRegionInput, + "street": ["xyz789"], + "telephone": "xyz789" } ``` -### Breadcrumb +### CompanyLegalAddressUpdateInput -Contains details about an individual category that comprises a breadcrumb. +Defines the input schema for updating a company's legal address. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](#int) | The category level. | -| `category_name` - [`String`](#string) | The display name of the category. | -| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](#string) | The URL key of the category. | -| `category_url_path` - [`String`](#string) | The URL path of the category. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | +| `postcode` - [`String`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](#string) | The primary phone number of the company. | #### Example ```json { - "category_id": 987, - "category_level": 987, - "category_name": "abc123", - "category_uid": "4", - "category_url_key": "abc123", - "category_url_path": "xyz789" + "city": "abc123", + "country_id": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["xyz789"], + "telephone": "xyz789" } ``` -### BundleCartItem +### CompanyRole -An implementation for bundle product cart items. +Contails details about a single role. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name assigned to the role. | +| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | +| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | #### Example ```json { - "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, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "id": "4", + "name": "xyz789", + "permissions": [CompanyAclResource], + "users_count": 123 } ``` -### BundleCreditMemoItem +### CompanyRoleCreateInput -Defines bundle product options for `CreditMemoItemInterface`. +Defines the input schema for creating a company role. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the role to create. | +| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 + "name": "abc123", + "permissions": ["xyz789"] } ``` -### BundleInvoiceItem +### CompanyRoleUpdateInput -Defines bundle product options for `InvoiceItemInterface`. +Defines the input schema for updating a company role. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| Input Field | Description | +|-------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name of the role to update. | +| `permissions` - [`[String]`](#string) | A list of resources the role can access. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 + "id": "4", + "name": "abc123", + "permissions": ["xyz789"] } ``` -### BundleItem +### CompanyRoles -Defines an individual item within a bundle product. +Contains an array of roles. #### Fields | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | -| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | -| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](#string) | The SKU of the bundle product. | -| `title` - [`String`](#string) | The display name of the item. | -| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | +| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | #### Example ```json { - "option_id": 987, - "options": [BundleItemOption], - "position": 987, - "price_range": PriceRange, - "required": true, - "sku": "xyz789", - "title": "xyz789", - "type": "xyz789", - "uid": "4" + "items": [CompanyRole], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### BundleItemOption +### CompanySalesRepresentative -Defines the characteristics that comprise a specific bundle item and its options. +Contains details about a company sales representative. #### Fields | Field Name | Description | |------------|-------------| -| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | -| `label` - [`String`](#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | +| `email` - [`String`](#string) | The email address of the company sales representative. | +| `firstname` - [`String`](#string) | The company sales representative's first name. | +| `lastname` - [`String`](#string) | The company sales representative's last name. | #### Example ```json { - "can_change_quantity": false, - "id": 987, - "is_default": false, - "label": "abc123", - "position": 123, - "price": 987.65, - "price_type": "FIXED", - "product": ProductInterface, - "qty": 123.45, - "quantity": 987.65, - "uid": 4 + "email": "abc123", + "firstname": "abc123", + "lastname": "abc123" } ``` -### BundleOptionInput +### CompanyStructure -Defines the input for a bundle option. +Contains an array of the individual nodes that comprise the company structure. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `id` - [`Int!`](#int) | The ID of the option. | -| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | #### Example ```json -{ - "id": 123, - "quantity": 123.45, - "value": ["abc123"] -} +{"items": [CompanyStructureItem]} ``` -### BundleOrderItem - -Defines bundle product options for `OrderItemInterface`. +### CompanyStructureEntity -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| Union Types | +|-------------| +| [`CompanyTeam`](#companyteam) | +| [`Customer`](#customer) | #### Example ```json -{ - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "eligible_for_return": true, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "product": ProductInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "xyz789", - "product_url_key": "xyz789", - "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "xyz789" -} +CompanyTeam ``` -### BundleProduct +### CompanyStructureItem -Defines basic features of a bundle product and contains multiple BundleItems. +Defines an individual node in the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | -| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | -| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | #### Example ```json { - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "dynamic_price": true, - "dynamic_sku": true, - "dynamic_weight": true, - "gift_message_available": "xyz789", - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "items": [BundleItem], - "manufacturer": 123, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", - "name": "abc123", - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "price": ProductPrices, - "price_details": PriceDetails, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "price_view": "PRICE_RANGE", - "product_links": [ProductLinksInterface], - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "reviews": ProductReviews, - "ship_bundle_items": "TOGETHER", - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": false, - "stock_status": "IN_STOCK", - "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": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website], - "weight": 987.65 + "entity": CompanyTeam, + "id": "4", + "parent_id": "4" } ``` -### BundleProductCartItemInput +### CompanyStructureUpdateInput -Defines a single bundle product. +Defines the input schema for updating the company structure. #### Input Fields | Input Field | Description | |-------------|-------------| -| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | +| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | #### Example ```json { - "bundle_options": [BundleOptionInput], - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput + "parent_tree_id": "4", + "tree_id": "4" } ``` -### BundleRequisitionListItem +### CompanyTeam -Contains details about bundle products added to a requisition list. +Describes a company team. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](#string) | The display name of the team. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | #### Example ```json { - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "description": "abc123", + "id": 4, + "name": "abc123", + "structure_id": "4" } ``` -### BundleShipmentItem +### CompanyTeamCreateInput -Defines bundle product options for `ShipmentItemInterface`. +Defines the input schema for creating a company team. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `name` - [`String!`](#string) | The display name of the team. | +| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "description": "xyz789", + "name": "xyz789", + "target_id": 4 } ``` -### BundleWishlistItem +### CompanyTeamUpdateInput -Defines bundle product options for `WishlistItemInterface`. +Defines the input schema for updating a company team. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](#string) | The display name of the team. | #### Example ```json { - "added_at": "xyz789", - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 + "id": "4", + "name": "abc123" } ``` -### ButtonStyles +### CompanyUpdateInput -#### Fields +Defines the input schema for updating a company. -| Field Name | Description | -|------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `label` - [`String`](#string) | The button label | -| `layout` - [`String`](#string) | The button layout | -| `shape` - [`String`](#string) | The button shape | -| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | -| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `company_email` - [`String`](#string) | The email address of the company contact. | +| `company_name` - [`String`](#string) | The name of the company to update. | +| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "color": "abc123", - "height": 987, - "label": "xyz789", - "layout": "abc123", - "shape": "abc123", - "tagline": false, - "use_default_height": false + "company_email": "abc123", + "company_name": "abc123", + "legal_address": CompanyLegalAddressUpdateInput, + "legal_name": "xyz789", + "reseller_id": "abc123", + "vat_tax_id": "xyz789" } ``` -### CancelNegotiableQuoteTemplateInput +### CompanyUserCreateInput -Specifies the quote template id of the quote template to cancel +Defines the input schema for creating a company user. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `email` - [`String!`](#string) | The company user's email address | +| `firstname` - [`String!`](#string) | The company user's first name. | +| `job_title` - [`String!`](#string) | The company user's job title or function. | +| `lastname` - [`String!`](#string) | The company user's last name. | +| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `target_id` - [`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!`](#string) | The company user's phone number. | #### Example ```json { - "cancellation_comment": "abc123", - "template_id": "4" + "email": "xyz789", + "firstname": "abc123", + "job_title": "xyz789", + "lastname": "abc123", + "role_id": 4, + "status": "ACTIVE", + "target_id": "4", + "telephone": "abc123" } ``` -### CancelOrderInput +### CompanyUserStatusEnum -Defines the order to cancel. +Defines the list of company user status values. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACTIVE` | Only active users. | +| `INACTIVE` | Only inactive users. | + +#### Example + +```json +""ACTIVE"" +``` + + + +### CompanyUserUpdateInput + +Defines the input schema for updating a company user. #### Input Fields | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](#id) | Order ID. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| `email` - [`String`](#string) | The company user's email address. | +| `firstname` - [`String`](#string) | The company user's first name. | +| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](#string) | The company user's job title or function. | +| `lastname` - [`String`](#string) | The company user's last name. | +| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The company user's phone number. | #### Example ```json -{"order_id": 4, "reason": "xyz789"} +{ + "email": "xyz789", + "firstname": "abc123", + "id": "4", + "job_title": "xyz789", + "lastname": "abc123", + "role_id": 4, + "status": "ACTIVE", + "telephone": "xyz789" +} ``` -### CancelOrderOutput +### CompanyUsers -Contains the updated customer order and error message if any. +Contains details about company users. #### Fields | Field Name | Description | |------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | -| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | +| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The number of objects returned. | #### Example ```json { - "error": "abc123", - "order": CustomerOrder + "items": [Customer], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### CancellationReason +### CompanyUsersFilterInput -#### Fields +Defines the filter for returning a list of company users. -| Field Name | Description | -|------------|-------------| -| `description` - [`String!`](#string) | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | #### Example ```json -{"description": "xyz789"} +{"status": "ACTIVE"} ``` -### Card +### ComparableAttribute + +Contains an attribute code that is used for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](#string) | Expiration year of the card | -| `last_digits` - [`String`](#string) | Last four digits of the card | -| `name` - [`String`](#string) | Name on the card | +| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](#string) | The label of the attribute code. | #### Example ```json { - "bin_details": CardBin, - "card_expiry_month": "xyz789", - "card_expiry_year": "abc123", - "last_digits": "xyz789", - "name": "xyz789" + "code": "abc123", + "label": "abc123" } ``` -### CardBin +### ComparableItem + +Defines an object used to iterate through items for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | #### Example ```json -{"bin": "xyz789"} +{ + "attributes": [ProductAttribute], + "product": ProductInterface, + "uid": "4" +} ``` -### Cart +### CompareList -Contains the contents and other details about a guest or customer cart. +Contains iterable information such as the array of items, the count, and attributes that represent the compare list. #### Fields | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. *(Deprecated: Use `itemsV2` instead.)* | -| `itemsV2` - [`CartItems`](#cartitems) | | -| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | +| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | +| `item_count` - [`Int!`](#int) | The number of items in the compare list. | +| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | #### Example ```json { - "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": false, - "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, - "items": [CartItemInterface], - "itemsV2": CartItems, - "prices": CartPrices, - "printed_card_included": false, - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "attributes": [ComparableAttribute], + "item_count": 987, + "items": [ComparableItem], + "uid": "4" } ``` -### CartAddressCountry - -Contains details the country in a billing or shipping address. +### ComplexTextValue #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `html` - [`String!`](#string) | Text that can contain HTML tags. | #### Example ```json -{ - "code": "abc123", - "label": "xyz789" -} +{"html": "xyz789"} ``` -### CartAddressInput +### ConfigurableAttributeOption -Defines the billing or shipping address to be applied to the cart. +Contains details about a configurable product attribute option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The ID assigned to the attribute. | +| `label` - [`String`](#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", - "country_code": "xyz789", - "custom_attributes": [AttributeValueInput], - "fax": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": "abc123", - "region_id": 123, - "save_in_address_book": false, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" + "code": "abc123", + "label": "xyz789", + "uid": 4, + "value_index": 987 } ``` -### CartAddressInterface +### ConfigurableCartItem + +An implementation for configurable product cart items. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | - -#### Possible Types - -| CartAddressInterface Types | -|----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "fax": "abc123", - "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", - "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "xyz789", - "vat_id": "xyz789" + "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": false, + "max_qty": 123.45, + "min_qty": 123.45, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" } ``` -### CartAddressRegion +### ConfigurableOptionAvailableForSelection -Contains details about the region in a billing or shipping address. +Describes configurable options that have been selected and can be selected as a result of the previous selections. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The state or province code. | -| `label` - [`String`](#string) | The display label for the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | #### Example ```json { - "code": "xyz789", - "label": "xyz789", - "region_id": 987 + "attribute_code": "abc123", + "option_value_uids": ["4"] } ``` -### CartDiscount +### ConfigurableProduct -Contains information about discounts applied to the cart. +Defines basic features of a configurable product and its simple product variants. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | +| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "amount": Money, - "label": ["xyz789"] + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 987, + "configurable_options": [ConfigurableProductOptions], + "configurable_product_options_selection": ConfigurableProductOptionsSelection, + "country_of_manufacture": "xyz789", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": "xyz789", + "id": 123, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": false, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "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": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "variants": [ConfigurableVariant], + "websites": [Website], + "weight": 987.65 } ``` -### CartDiscountType +### ConfigurableProductCartItemInput -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `ITEM` | | -| `SHIPPING` | | +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | +| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](#string) | Deprecated. Use `CartItemInput.sku` instead. | #### Example ```json -""ITEM"" +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "parent_sku": "xyz789", + "variant_sku": "abc123" +} ``` -### CartItemError +### ConfigurableProductOption + +Contains details about configurable product options. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](#string) | The display name of the option. | +| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | +| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{ + "attribute_code": "abc123", + "label": "xyz789", + "uid": 4, + "values": [ConfigurableProductOptionValue] +} ``` -### CartItemErrorType +### ConfigurableProductOptionValue -#### Values +Defines a value for a configurable product option. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `UNDEFINED` | | -| `ITEM_QTY` | | -| `ITEM_INCREMENTS` | | +| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](#id) | The unique ID of the value. | #### Example ```json -""UNDEFINED"" +{ + "is_available": true, + "is_use_default": false, + "label": "xyz789", + "swatch": SwatchDataInterface, + "uid": 4 +} ``` -### CartItemInput +### ConfigurableProductOptions -Defines an item to be added to the cart. +Defines configurable attributes for the specified product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | +| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | #### Example ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 123.45, - "selected_options": ["4"], - "sku": "xyz789" + "attribute_code": "abc123", + "attribute_id": "xyz789", + "attribute_id_v2": 123, + "attribute_uid": 4, + "id": 987, + "label": "abc123", + "position": 987, + "product_id": 987, + "uid": "4", + "use_default": true, + "values": [ConfigurableProductOptionsValues] } ``` -### CartItemInterface +### ConfigurableProductOptionsSelection -An interface for products in a cart. +Contains metadata corresponding to the selected configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Possible Types - -| CartItemInterface Types | -|----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | -| [`ConfigurableCartItem`](#configurablecartitem) | -| [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | +| `variant` - [`SimpleProduct`](#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 ```json { - "discount": [Discount], - "errors": [CartItemError], - "id": "abc123", - "is_available": true, - "max_qty": 987.65, - "min_qty": 123.45, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "configurable_options": [ConfigurableProductOption], + "media_gallery": [MediaGalleryInterface], + "options_available_for_selection": [ + ConfigurableOptionAvailableForSelection + ], + "variant": SimpleProduct } ``` -### CartItemPrices +### ConfigurableProductOptionsValues -Contains details about the price of the item, including taxes and discounts. +Contains the index number assigned to a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | -| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | +| `default_label` - [`String`](#string) | The label of the product on the default store. | +| `label` - [`String`](#string) | The label of the product. | +| `store_label` - [`String`](#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "discounts": [Discount], - "fixed_product_taxes": [FixedProductTax], - "price": Money, - "price_including_tax": Money, - "row_total": Money, - "row_total_including_tax": Money, - "total_item_discount": Money + "default_label": "xyz789", + "label": "xyz789", + "store_label": "abc123", + "swatch_data": SwatchDataInterface, + "uid": "4", + "use_default_value": false, + "value_index": 123 } ``` -### CartItemQuantity +### ConfigurableRequisitionListItem -Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. +Contains details about configurable products added to a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json -{"cart_item_id": 987, "quantity": 987.65} +{ + "configurable_options": [SelectedConfigurableOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" +} ``` -### CartItemSelectedOptionValuePrice +### ConfigurableVariant -Contains details about the price of a selected customizable value. +Contains all the simple product variants of a configurable product. #### Fields | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](#float) | A price value. | +| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | +| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | #### Example ```json { - "type": "FIXED", - "units": "abc123", - "value": 987.65 + "attributes": [ConfigurableAttributeOption], + "product": SimpleProduct } ``` -### CartItemUpdateInput +### ConfigurableWishlistItem -A single item to be updated. +A configurable product wish list item. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "cart_item_id": 123, - "cart_item_uid": "4", - "customizable_options": [CustomizableOptionInput], - "gift_message": GiftMessageInput, - "gift_wrapping_id": "4", - "quantity": 987.65 + "added_at": "abc123", + "child_sku": "abc123", + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 } ``` -### CartItems +### ConfirmEmailInput -#### Fields +Contains details about a customer email address to confirm. -| Field Name | Description | -|------------|-------------| -| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned cart items. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | +| `email` - [`String!`](#string) | The email address to be confirmed. | #### Example ```json { - "items": [CartItemInterface], - "page_info": SearchResultPageInfo, - "total_count": 987 + "confirmation_key": "xyz789", + "email": "abc123" } ``` -### CartPrices +### ConfirmationStatusEnum -Contains details about the final price of items in the cart, including discount and tax information. +List of account confirmation statuses. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | -| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | -| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | +| `ACCOUNT_CONFIRMED` | Account confirmed | +| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | #### Example ```json -{ - "applied_taxes": [CartTaxItem], - "discount": CartDiscount, - "discounts": [Discount], - "gift_options": GiftOptionsPrices, - "grand_total": Money, - "subtotal_excluding_tax": Money, - "subtotal_including_tax": Money, - "subtotal_with_discount_excluding_tax": Money -} +""ACCOUNT_CONFIRMED"" ``` -### CartTaxItem - -Contains tax information about an item in the cart. +### ContactUsInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](#string) | The email address of the shopper. | +| `name` - [`String!`](#string) | The full name of the shopper. | +| `telephone` - [`String`](#string) | The shopper's telephone number. | #### Example ```json { - "amount": Money, - "label": "abc123" + "comment": "abc123", + "email": "xyz789", + "name": "xyz789", + "telephone": "abc123" } ``` -### CartUserInputError +### ContactUsOutput -An error encountered while adding an item to the the cart. +Contains the status of the request. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | #### Example ```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" -} -``` - - - -### CartUserInputErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | -| `PERMISSION_DENIED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### CatalogAttributeApplyToEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SIMPLE` | | -| `VIRTUAL` | | -| `BUNDLE` | | -| `DOWNLOADABLE` | | -| `CONFIGURABLE` | | -| `GROUPED` | | -| `CATEGORY` | | - -#### Example - -```json -""SIMPLE"" -``` - - - -### CatalogAttributeMetadata - -Swatch attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | - -#### Example - -```json -{ - "apply_to": ["SIMPLE"], - "code": "4", - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_comparable": false, - "is_filterable": false, - "is_filterable_in_search": true, - "is_html_allowed_on_front": true, - "is_required": 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": true, - "label": "xyz789", - "options": [CustomAttributeOptionInterface], - "swatch_input_type": "BOOLEAN", - "update_product_preview_image": true, - "use_product_image_for_swatch": true, - "used_in_product_listing": false -} +{"status": true} ``` -### CategoryFilterInput +### CopyItemsBetweenRequisitionListsInput -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. +An input object that defines the items in a requisition list to be copied. #### Input Fields | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{ - "category_uid": FilterEqualTypeInput, - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput, - "parent_category_uid": FilterEqualTypeInput, - "parent_id": FilterEqualTypeInput, - "url_key": FilterEqualTypeInput, - "url_path": FilterEqualTypeInput -} +{"requisitionListItemUids": [4]} ``` -### CategoryInterface +### CopyItemsFromRequisitionListsOutput -Contains the full set of attributes that can be returned in a category search. +Output of the request to copy items to the destination requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | - -#### Possible Types - -| CategoryInterface Types | -|----------------| -| [`CategoryTree`](#categorytree) | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | #### Example ```json -{ - "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", - "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": 987.65, - "id": 987, - "image": "abc123", - "include_in_menu": 987, - "is_anchor": 987, - "landing_page": 123, - "level": 123, - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "xyz789", - "name": "abc123", - "path": "xyz789", - "path_in_store": "abc123", - "position": 123, - "product_count": 987, - "products": CategoryProducts, - "staged": false, - "uid": "4", - "updated_at": "abc123", - "url_key": "xyz789", - "url_path": "xyz789", - "url_suffix": "xyz789" -} +{"requisition_list": RequisitionList} ``` -### CategoryProducts +### CopyProductsBetweenWishlistsOutput -Contains details about the products assigned to a category. +Contains the source and target wish lists after copying products. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#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. | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example ```json { - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "total_count": 987 + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] } ``` -### CategoryResult - -Contains a collection of `CategoryTree` objects and pagination information. +### Country #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | +| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](#string) | The name of the country in English. | +| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | +| `id` - [`String`](#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { - "items": [CategoryTree], - "page_info": SearchResultPageInfo, - "total_count": 987 + "available_regions": [Region], + "full_name_english": "abc123", + "full_name_locale": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "abc123", + "two_letter_abbreviation": "abc123" } ``` -### CategoryTree +### CountryCodeEnum -Contains the hierarchy of categories. +The list of country codes. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | -| `children_count` - [`String`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | +| `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 ```json -{ - "automatic_sorting": "xyz789", - "available_sort_by": ["abc123"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children": [CategoryTree], - "children_count": "xyz789", - "cms_block": CmsBlock, - "created_at": "xyz789", - "custom_layout_update_file": "abc123", - "default_sort_by": "xyz789", - "description": "abc123", - "display_mode": "abc123", - "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": "xyz789", - "name": "xyz789", - "path": "abc123", - "path_in_store": "abc123", - "position": 987, - "product_count": 987, - "products": CategoryProducts, - "redirect_code": 987, - "relative_url": "xyz789", - "staged": false, - "type": "CMS_PAGE", - "uid": "4", - "updated_at": "abc123", - "url_key": "abc123", - "url_path": "xyz789", - "url_suffix": "abc123" -} +""AF"" ``` -### CheckoutAgreement +### CreateCompanyOutput -Defines details about an individual checkout agreement. +Contains the response to the request to create a company. #### Fields | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](#string) | Required. The text of the agreement. | -| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | -| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](#string) | The name given to the condition. | +| `company` - [`Company!`](#company) | The new company instance. | #### Example ```json -{ - "agreement_id": 987, - "checkbox_text": "xyz789", - "content": "xyz789", - "content_height": "xyz789", - "is_html": true, - "mode": "AUTO", - "name": "abc123" -} +{"company": Company} ``` -### CheckoutAgreementMode +### CreateCompanyRoleOutput -Indicates how agreements are accepted. +Contains the response to the request to create a company role. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `AUTO` | Conditions are automatically accepted upon checkout. | -| `MANUAL` | Shoppers must manually accept the conditions to place an order. | +| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | #### Example ```json -""AUTO"" +{"role": CompanyRole} ``` -### CheckoutUserInputError +### CreateCompanyTeamOutput -An error encountered while adding an item to the cart. +Contains the response to the request to create a company team. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](#string) | A localized error message. | -| `path` - [`[String]!`](#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 - -```json -{ - "code": "REORDER_NOT_AVAILABLE", - "message": "abc123", - "path": ["abc123"] -} -``` - - - -### CheckoutUserInputErrorCodes - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REORDER_NOT_AVAILABLE` | | -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | +| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | #### Example ```json -""REORDER_NOT_AVAILABLE"" +{"team": CompanyTeam} ``` -### ClearCartError +### CreateCompanyUserOutput -Contains details about errors encountered when a customer clear cart. +Contains the response to the request to create a company user. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A localized error message | -| `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | - -#### Example - -```json -{"message": "xyz789", "type": "NOT_FOUND"} -``` - - - -### ClearCartErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `UNAUTHORISED` | | -| `INACTIVE` | | -| `UNDEFINED` | | +| `user` - [`Customer!`](#customer) | The new company user instance. | #### Example ```json -""NOT_FOUND"" +{"user": Customer} ``` -### ClearCartInput +### CreateCompareListInput -Assigns a specific `cart_id` to the empty cart. +Contains an array of product IDs to use for creating a compare list. #### Input Fields | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | +| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | #### Example ```json -{"uid": "4"} +{"products": [4]} ``` -### ClearCartOutput +### CreateGiftRegistryInput -Output of the request to clear the customer cart. +Defines a new gift registry. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clear cart items. | -| `errors` - [`[ClearCartError]`](#clearcarterror) | An array of errors encountered while clearing the cart item | +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | +| `message` - [`String!`](#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example ```json { - "cart": Cart, - "errors": [ClearCartError] + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "xyz789", + "gift_registry_type_uid": "4", + "message": "abc123", + "privacy_settings": "PRIVATE", + "registrants": [AddGiftRegistryRegistrantInput], + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" } ``` -### ClearCustomerCartOutput +### CreateGiftRegistryOutput -Output of the request to clear the customer cart. +Contains the results of a request to create a gift registry. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | #### Example ```json -{"cart": Cart, "status": false} +{"gift_registry": GiftRegistry} ``` -### CloseNegotiableQuoteError +### CreateGuestCartInput -#### Types +#### Input Fields -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +| Input Field | Description | +|-------------|-------------| +| `cart_uid` - [`ID`](#id) | Optional client-generated ID | #### Example ```json -NegotiableQuoteInvalidStateError +{"cart_uid": 4} ``` -### CloseNegotiableQuoteOperationFailure - -Contains details about a failed close operation on a negotiable quote. +### CreateGuestCartOutput #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" -} -``` - - - -### CloseNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | - -#### Example - -```json -NegotiableQuoteUidOperationSuccess -``` - - - -### CloseNegotiableQuotesInput - -Defines the negotiable quotes to mark as closed. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `cart` - [`Cart`](#cart) | The newly created cart. | #### Example ```json -{"quote_uids": [4]} +{"cart": Cart} ``` -### CloseNegotiableQuotesOutput +### CreatePayflowProTokenOutput -Contains the closed negotiable quotes and other negotiable quotes the company user can view. +Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | -| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | #### Example ```json { - "closed_quotes": [NegotiableQuote], - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" + "response_message": "xyz789", + "result": 123, + "result_code": 123, + "secure_token": "xyz789", + "secure_token_id": "xyz789" } ``` -### CmsBlock +### CreatePaymentOrderInput -Contains details about a specific CMS block. +Contains payment order details that are used while processing the payment order -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](#string) | The CMS block identifier. | -| `title` - [`String`](#string) | The title assigned to the CMS block. | +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json { - "content": "abc123", - "identifier": "abc123", - "title": "abc123" + "cartId": "xyz789", + "location": "PRODUCT_DETAIL", + "methodCode": "abc123", + "paymentSource": "xyz789", + "vaultIntent": false } ``` -### CmsBlocks +### CreatePaymentOrderOutput -Contains an array CMS block items. +Contains payment order details that are used while processing the payment order #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | +| `amount` - [`Float`](#float) | The amount of the payment order | +| `currency_code` - [`String`](#string) | The currency of the payment order | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json -{"items": [CmsBlock]} +{ + "amount": 123.45, + "currency_code": "abc123", + "id": "xyz789", + "mp_order_id": "abc123", + "status": "abc123" +} ``` -### CmsPage +### CreateProductReviewInput -Contains details about a CMS page. +Defines a new product review. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](#string) | The ID of a CMS page. | -| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| Input Field | Description | +|-------------|-------------| +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json { - "content": "xyz789", - "content_heading": "xyz789", - "identifier": "xyz789", - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "page_layout": "xyz789", - "redirect_code": 987, - "relative_url": "abc123", - "title": "xyz789", - "type": "CMS_PAGE", - "url_key": "xyz789" + "nickname": "abc123", + "ratings": [ProductReviewRatingInput], + "sku": "abc123", + "summary": "xyz789", + "text": "xyz789" } ``` -### ColorSwatchData +### CreateProductReviewOutput + +Contains the completed product review. #### Fields | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `review` - [`ProductReview!`](#productreview) | Product review details. | #### Example ```json -{"value": "abc123"} +{"review": ProductReview} ``` -### CompaniesSortFieldEnum +### CreatePurchaseOrderApprovalRuleConditionAmountInput -The fields available for sorting the customer companies. +Specifies the amount and currency to evaluate. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `NAME` | The name of the company. | +| Input Field | Description | +|-------------|-------------| +| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | +| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | #### Example ```json -""NAME"" +{"currency": "AFN", "value": 123.45} ``` -### CompaniesSortInput +### CreatePurchaseOrderApprovalRuleConditionInput -Specifies which field to sort on, and whether to return the results in ascending or descending order. +Defines a set of conditions that apply to a rule. #### Input Fields | Input Field | Description | |-------------|-------------| -| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | +| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example ```json -{"field": "NAME", "order": "ASC"} +{ + "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN", + "quantity": 123 +} ``` -### Company +### CreateRequisitionListInput -Contains the output schema for a company. +An input object that identifies and describes a new requisition list. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | -| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | -| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | -| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | -| `email` - [`String`](#string) | The email address of the company contact. | -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | -| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | -| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | -| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | -| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | -| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | -| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the requisition list. | +| `name` - [`String!`](#string) | The name assigned to the requisition list. | #### Example ```json { - "acl_resources": [CompanyAclResource], - "company_admin": Customer, - "credit": CompanyCredit, - "credit_history": CompanyCreditHistory, - "email": "xyz789", - "id": 4, - "legal_address": CompanyLegalAddress, - "legal_name": "abc123", - "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" + "description": "abc123", + "name": "xyz789" } ``` -### CompanyAclResource +### CreateRequisitionListOutput -Contains details about the access control list settings of a resource. +Output of the request to create a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | -| `text` - [`String`](#string) | The label assigned to the ACL resource. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | #### Example ```json -{ - "children": [CompanyAclResource], - "id": 4, - "sort_order": 123, - "text": "abc123" -} +{"requisition_list": RequisitionList} ``` -### CompanyAdminInput +### CreateWishlistInput -Defines the input schema for creating a company administrator. +Defines the name and visibility of a new wish list. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | The email address of the company administrator. | -| `firstname` - [`String!`](#string) | The company administrator's first name. | -| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](#string) | The job title of the company administrator. | -| `lastname` - [`String!`](#string) | The company administrator's last name. | +| `name` - [`String!`](#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -{ - "email": "abc123", - "firstname": "abc123", - "gender": 123, - "job_title": "abc123", - "lastname": "xyz789" -} +{"name": "xyz789", "visibility": "PUBLIC"} ``` -### CompanyBasicInfo +### CreateWishlistOutput -The minimal required information to identify and display the company. +Contains the wish list. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | +| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | #### Example ```json -{ - "id": "4", - "legal_name": "abc123", - "name": "xyz789" -} +{"wishlist": Wishlist} ``` -### CompanyCreateInput +### CreditCardDetailsInput -Defines the input schema for creating a new company. +Required fields for Payflow Pro and Payments Pro credit card payments. #### Input Fields | Input Field | Description | |-------------|-------------| -| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](#string) | The email address of the company contact. | -| `company_name` - [`String!`](#string) | The name of the company to create. | -| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](#string) | The credit card type. | #### Example ```json { - "company_admin": CompanyAdminInput, - "company_email": "xyz789", - "company_name": "abc123", - "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", - "reseller_id": "abc123", - "vat_tax_id": "abc123" + "cc_exp_month": 123, + "cc_exp_year": 987, + "cc_last_4": 123, + "cc_type": "abc123" } ``` -### CompanyCredit +### CreditMemo -Contains company credit balances and limits. +Contains credit memo details. #### Fields | Field Name | Description | |------------|-------------| -| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](#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. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | +| `number` - [`String!`](#string) | The sequential credit memo number. | +| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "id": 4, + "items": [CreditMemoItemInterface], + "number": "abc123", + "total": CreditMemoTotal +} +``` + + + +### CreditMemoItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json { - "available_credit": Money, - "credit_limit": Money, - "outstanding_balance": Money + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 123.45 } ``` -### CompanyCreditHistory +### CreditMemoItemInterface -Contains details about prior company credit operations. +Credit memo item details. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Possible Types + +| CreditMemoItemInterface Types | +|----------------| +| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | +| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`CreditMemoItem`](#creditmemoitem) | #### Example ```json { - "items": [CompanyCreditOperation], - "page_info": SearchResultPageInfo, - "total_count": 123 + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` -### CompanyCreditHistoryFilterInput +### CreditMemoTotal -Defines a filter for narrowing the results of a credit history search. +Contains credit memo price details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | +| Field Name | Description | +|------------|-------------| +| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | #### Example ```json { - "custom_reference_number": "abc123", - "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "adjustment": Money, + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money } ``` -### CompanyCreditOperation - -Contains details about a single company credit operation. +### Currency #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | -| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](#string) | The date the operation occurred. | -| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | +| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | +| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | #### Example ```json { - "amount": Money, - "balance": CompanyCredit, - "custom_reference_number": "abc123", - "date": "abc123", - "type": "ALLOCATION", - "updated_by": CompanyCreditOperationUser + "available_currency_codes": ["abc123"], + "base_currency_code": "abc123", + "base_currency_symbol": "abc123", + "default_display_currecy_code": "abc123", + "default_display_currecy_symbol": "abc123", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "xyz789", + "exchange_rates": [ExchangeRate] } ``` -### CompanyCreditOperationType +### CurrencyEnum + +The list of available currency codes. #### Values | Enum Value | Description | |------------|-------------| -| `ALLOCATION` | | -| `UPDATE` | | -| `PURCHASE` | | -| `REIMBURSEMENT` | | -| `REFUND` | | -| `REVERT` | | +| `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 ```json -""ALLOCATION"" +""AFN"" ``` -### CompanyCreditOperationUser +### CustomAttributeMetadata -Defines the administrator or company user that submitted a company credit operation. +Defines an array of custom attributes. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | -| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | +| `items` - [`[Attribute]`](#attribute) | An array of attributes. | #### Example ```json -{"name": "xyz789", "type": "CUSTOMER"} +{"items": [Attribute]} ``` -### CompanyCreditOperationUserType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CUSTOMER` | | -| `ADMIN` | | - -#### Example - -```json -""CUSTOMER"" -``` +### CustomAttributeMetadataInterface - +An interface containing fields that define the EAV attribute. -### CompanyInvitationInput +#### Fields -Defines the input schema for accepting the company invitation. +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | -| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | +| CustomAttributeMetadataInterface Types | +|----------------| +| [`AttributeMetadata`](#attributemetadata) | +| [`CatalogAttributeMetadata`](#catalogattributemetadata) | +| [`CustomerAttributeMetadata`](#customerattributemetadata) | +| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | #### Example ```json { - "code": "abc123", - "role_id": "4", - "user": CompanyInvitationUserInput + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "abc123", + "frontend_input": "BOOLEAN", + "is_required": false, + "is_unique": true, + "label": "xyz789", + "options": [CustomAttributeOptionInterface] } ``` -### CompanyInvitationOutput - -The result of accepting the company invitation. +### CustomAttributeOptionInterface #### Fields | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | - -#### Example - -```json -{"success": false} -``` - - - -### CompanyInvitationUserInput - -Company user attributes in the invitation. +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `company_id` - [`ID!`](#id) | The company unique identifier. | -| `customer_id` - [`ID!`](#id) | The customer unique identifier. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The phone number of the company user. | +| CustomAttributeOptionInterface Types | +|----------------| +| [`AttributeOptionMetadata`](#attributeoptionmetadata) | #### Example ```json { - "company_id": "4", - "customer_id": "4", - "job_title": "abc123", - "status": "ACTIVE", - "telephone": "abc123" + "is_default": false, + "label": "xyz789", + "value": "xyz789" } ``` -### CompanyLegalAddress +### Customer -Contains details about the address where the company is registered to conduct business. +Defines the customer name, addresses, and other details. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | -| `postcode` - [`String`](#string) | The company's postal code. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](#string) | The company's phone number. | - -#### Example - -```json -{ - "city": "xyz789", - "country_code": "AF", - "postcode": "abc123", - "region": CustomerAddressRegion, - "street": ["xyz789"], - "telephone": "abc123" -} -``` - - - -### CompanyLegalAddressCreateInput - -Defines the input schema for defining a company's legal address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | -| `postcode` - [`String!`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](#string) | The primary phone number of the company. | +| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | +| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](#string) | The customer's email address. Required. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | +| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](#int) | The ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `orders` - [`CustomerOrders`](#customerorders) | | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | +| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | +| `telephone` - [`String`](#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](#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. | #### Example ```json { - "city": "abc123", - "country_id": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "abc123" + "addresses": [CustomerAddress], + "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": "abc123", + "default_shipping": "abc123", + "dob": "abc123", + "email": "xyz789", + "firstname": "abc123", + "gender": 987, + "gift_registries": [GiftRegistry], + "gift_registry": GiftRegistry, + "group_id": 987, + "id": 123, + "is_subscribed": true, + "job_title": "xyz789", + "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": true, + "requisition_lists": RequisitionLists, + "return": Return, + "returns": Returns, + "reviews": ProductReviews, + "reward_points": RewardPoints, + "role": CompanyRole, + "status": "ACTIVE", + "store_credit": CustomerStoreCredit, + "structure_id": 4, + "suffix": "xyz789", + "taxvat": "abc123", + "team": CompanyTeam, + "telephone": "abc123", + "wishlist": Wishlist, + "wishlist_v2": Wishlist, + "wishlists": [Wishlist] } ``` -### CompanyLegalAddressUpdateInput - -Defines the input schema for updating a company's legal address. +### CustomerAddress -#### Input Fields +Contains detailed information about a customer's billing or shipping address. -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](#string) | The primary phone number of the company. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | +| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "country_id": "AF", - "postcode": "abc123", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "abc123" + "city": "abc123", + "company": "xyz789", + "country_code": "AF", + "country_id": "xyz789", + "custom_attributes": [CustomerAddressAttribute], + "custom_attributesV2": [AttributeValueInterface], + "customer_id": 987, + "default_billing": false, + "default_shipping": true, + "extension_attributes": [CustomerAddressAttribute], + "fax": "xyz789", + "firstname": "abc123", + "id": 987, + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CustomerAddressRegion, + "region_id": 987, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "abc123" } ``` -### CompanyRole +### CustomerAddressAttribute -Contails details about a single role. +Specifies the attribute code and value of a customer address attribute. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | -| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | +| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](#string) | The value assigned to the customer address attribute. | #### Example ```json { - "id": 4, - "name": "xyz789", - "permissions": [CompanyAclResource], - "users_count": 123 + "attribute_code": "abc123", + "value": "xyz789" } ``` -### CompanyRoleCreateInput +### CustomerAddressAttributeInput -Defines the input schema for creating a company role. +Specifies the attribute code and value of a customer attribute. #### Input Fields | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | +| `value` - [`String!`](#string) | The value assigned to the attribute. | #### Example ```json { - "name": "xyz789", - "permissions": ["abc123"] + "attribute_code": "xyz789", + "value": "abc123" } ``` -### CompanyRoleUpdateInput +### CustomerAddressInput -Defines the input schema for updating a company role. +Contains details about a billing or shipping address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name of the role to update. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | Deprecated: use `country_code` instead. | +| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | Deprecated. Use custom_attributesV2 instead. | +| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "id": "4", - "name": "abc123", - "permissions": ["abc123"] + "city": "abc123", + "company": "xyz789", + "country_code": "AF", + "country_id": "AF", + "custom_attributes": [CustomerAddressAttributeInput], + "custom_attributesV2": [AttributeValueInput], + "default_billing": true, + "default_shipping": true, + "fax": "xyz789", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "abc123" } ``` -### CompanyRoles +### CustomerAddressRegion -Contains an array of roles. +Defines the customer's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "items": [CompanyRole], - "page_info": SearchResultPageInfo, - "total_count": 987 + "region": "abc123", + "region_code": "abc123", + "region_id": 123 } ``` -### CompanySalesRepresentative +### CustomerAddressRegionInput -Contains details about a company sales representative. +Defines the customer's state or province. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `email` - [`String`](#string) | The email address of the company sales representative. | -| `firstname` - [`String`](#string) | The company sales representative's first name. | -| `lastname` - [`String`](#string) | The company sales representative's last name. | +| Input Field | Description | +|-------------|-------------| +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "email": "abc123", - "firstname": "xyz789", - "lastname": "abc123" + "region": "abc123", + "region_code": "abc123", + "region_id": 987 } ``` -### CompanyStructure +### CustomerAttributeMetadata -Contains an array of the individual nodes that comprise the company structure. +Customer attribute metadata. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | #### Example ```json -{"items": [CompanyStructureItem]} +{ + "code": 4, + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "abc123", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": false, + "is_unique": true, + "label": "abc123", + "multiline_count": 987, + "options": [CustomAttributeOptionInterface], + "sort_order": 123, + "validate_rules": [ValidationRule] +} ``` -### CompanyStructureEntity +### CustomerCreateInput -#### Types +An input object for creating a customer. -| Union Types | -|-------------| -| [`CompanyTeam`](#companyteam) | -| [`Customer`](#customer) | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String!`](#string) | The customer's email address. | +| `firstname` - [`String!`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json -CompanyTeam +{ + "allow_remote_shopping_assistance": false, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "abc123", + "dob": "xyz789", + "email": "xyz789", + "firstname": "abc123", + "gender": 123, + "is_subscribed": true, + "lastname": "abc123", + "middlename": "xyz789", + "password": "abc123", + "prefix": "xyz789", + "suffix": "xyz789", + "taxvat": "xyz789" +} ``` -### CompanyStructureItem +### CustomerDownloadableProduct -Defines an individual node in the company structure. +Contains details about a single downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | - -#### Example - -```json -{"entity": CompanyTeam, "id": 4, "parent_id": 4} -``` - - - -### CompanyStructureUpdateInput - -Defines the input schema for updating the company structure. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | +| `date` - [`String`](#string) | The date and time the purchase was made. | +| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json -{"parent_tree_id": 4, "tree_id": 4} +{ + "date": "xyz789", + "download_url": "abc123", + "order_increment_id": "abc123", + "remaining_downloads": "abc123", + "status": "xyz789" +} ``` -### CompanyTeam +### CustomerDownloadableProducts -Describes a company team. +Contains a list of downloadable products. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](#string) | The display name of the team. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | #### Example ```json -{ - "description": "abc123", - "id": "4", - "name": "abc123", - "structure_id": "4" -} +{"items": [CustomerDownloadableProduct]} ``` -### CompanyTeamCreateInput +### CustomerInput -Defines the input schema for creating a company team. +An input object that assigns or updates customer attributes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `name` - [`String!`](#string) | The display name of the team. | -| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | +| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "description": "xyz789", - "name": "abc123", - "target_id": "4" + "date_of_birth": "abc123", + "dob": "xyz789", + "email": "xyz789", + "firstname": "xyz789", + "gender": 123, + "is_subscribed": true, + "lastname": "abc123", + "middlename": "xyz789", + "password": "abc123", + "prefix": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789" } ``` -### CompanyTeamUpdateInput +### CustomerOrder -Defines the input schema for updating a company team. +Contains details about each of the customer's orders. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](#string) | The display name of the team. | +| Field Name | Description | +|------------|-------------| +| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | +| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | +| `email` - [`String`](#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | +| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](#string) | The order number. | +| `order_date` - [`String!`](#string) | The date the order was placed. | +| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | +| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](#string) | The delivery method for the order. | +| `status` - [`String!`](#string) | The current status of the order. | +| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | #### Example ```json { - "description": "xyz789", - "id": "4", - "name": "xyz789" + "applied_coupons": [AppliedCoupon], + "billing_address": OrderAddress, + "carrier": "abc123", + "comments": [SalesCommentItem], + "created_at": "abc123", + "credit_memos": [CreditMemo], + "email": "xyz789", + "gift_message": GiftMessage, + "gift_receipt_included": false, + "gift_wrapping": GiftWrapping, + "grand_total": 987.65, + "id": 4, + "increment_id": "abc123", + "invoices": [Invoice], + "items": [OrderItemInterface], + "items_eligible_for_return": [OrderItemInterface], + "number": "abc123", + "order_date": "xyz789", + "order_number": "xyz789", + "payment_methods": [OrderPaymentMethod], + "printed_card_included": true, + "returns": Returns, + "shipments": [OrderShipment], + "shipping_address": OrderAddress, + "shipping_method": "xyz789", + "status": "xyz789", + "token": "abc123", + "total": OrderTotal } ``` -### CompanyUpdateInput +### CustomerOrderSortInput -Defines the input schema for updating a company. +CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. #### Input Fields | Input Field | Description | |-------------|-------------| -| `company_email` - [`String`](#string) | The email address of the company contact. | -| `company_name` - [`String`](#string) | The name of the company to update. | -| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | #### Example ```json -{ - "company_email": "xyz789", - "company_name": "xyz789", - "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", - "reseller_id": "abc123", - "vat_tax_id": "xyz789" -} +{"sort_direction": "ASC", "sort_field": "NUMBER"} ``` -### CompanyUserCreateInput +### CustomerOrderSortableField -Defines the input schema for creating a company user. +Specifies the field to use for sorting -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The company user's email address | -| `firstname` - [`String!`](#string) | The company user's first name. | -| `job_title` - [`String!`](#string) | The company user's job title or function. | -| `lastname` - [`String!`](#string) | The company user's last name. | -| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`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!`](#string) | The company user's phone number. | +| Enum Value | Description | +|------------|-------------| +| `NUMBER` | Sorts customer orders by number | +| `CREATED_AT` | Sorts customer orders by created_at field | #### Example ```json -{ - "email": "xyz789", - "firstname": "abc123", - "job_title": "abc123", - "lastname": "abc123", - "role_id": "4", - "status": "ACTIVE", - "target_id": "4", - "telephone": "xyz789" -} +""NUMBER"" ``` -### CompanyUserStatusEnum +### CustomerOrders -Defines the list of company user status values. +The collection of orders that match the conditions defined in the filter. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACTIVE` | Only active users. | -| `INACTIVE` | Only inactive users. | +| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer orders. | #### Example ```json -""ACTIVE"" +{ + "items": [CustomerOrder], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### CompanyUserUpdateInput +### CustomerOrdersFilterInput -Defines the input schema for updating a company user. +Identifies the filter to use for filtering orders. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String`](#string) | The company user's email address. | -| `firstname` - [`String`](#string) | The company user's first name. | -| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](#string) | The company user's job title or function. | -| `lastname` - [`String`](#string) | The company user's last name. | -| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The company user's phone number. | +| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | #### Example ```json -{ - "email": "abc123", - "firstname": "abc123", - "id": "4", - "job_title": "xyz789", - "lastname": "abc123", - "role_id": "4", - "status": "ACTIVE", - "telephone": "abc123" -} +{"number": FilterStringTypeInput} ``` -### CompanyUsers +### CustomerOutput -Contains details about company users. +Contains details about a newly-created or updated customer. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The number of objects returned. | +| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | #### Example ```json -{ - "items": [Customer], - "page_info": SearchResultPageInfo, - "total_count": 123 -} +{"customer": Customer} ``` -### CompanyUsersFilterInput +### CustomerPaymentTokens -Defines the filter for returning a list of company users. +Contains payment tokens stored in the customer's vault. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | #### Example ```json -{"status": "ACTIVE"} +{"items": [PaymentToken]} ``` -### ComparableAttribute +### CustomerStoreCredit -Contains an attribute code that is used for product comparisons. +Contains store credit information with balance and history. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `balance_history` - [`CustomerStoreCreditHistory`](#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. | +| `current_balance` - [`Money`](#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example ```json { - "code": "abc123", - "label": "xyz789" + "balance_history": CustomerStoreCreditHistory, + "current_balance": Money, + "enabled": true } ``` -### ComparableItem +### CustomerStoreCreditHistory -Defines an object used to iterate through items for product comparisons. +Lists changes to the amount of store credit available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | +| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of items returned. | #### Example ```json { - "attributes": [ProductAttribute], - "product": ProductInterface, - "uid": "4" + "items": [CustomerStoreCreditHistoryItem], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### CompareList +### CustomerStoreCreditHistoryItem -Contains iterable information such as the array of items, the count, and attributes that represent the compare list. +Contains store credit history information. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](#int) | The number of items in the compare list. | -| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | +| `action` - [`String`](#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | #### Example ```json { - "attributes": [ComparableAttribute], - "item_count": 123, - "items": [ComparableItem], - "uid": "4" + "action": "xyz789", + "actual_balance": Money, + "balance_change": Money, + "date_time_changed": "abc123" } ``` -### ComplexTextValue +### CustomerToken + +Contains a customer authorization token. #### Fields | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `token` - [`String`](#string) | The customer authorization token. | #### Example ```json -{"html": "abc123"} +{"token": "abc123"} ``` -### ConfigurableAttributeOption +### CustomerUpdateInput -Contains details about a configurable product attribute option. +An input object for updating a customer. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | Deprecated: Use `date_of_birth` instead. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | + +#### Example + +```json +{ + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "xyz789", + "dob": "abc123", + "firstname": "abc123", + "gender": 987, + "is_subscribed": true, + "lastname": "xyz789", + "middlename": "abc123", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "abc123" +} +``` + + + +### CustomizableAreaOption + +Contains information about a text area that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The ID assigned to the attribute. | -| `label` - [`String`](#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "code": "xyz789", - "label": "abc123", - "uid": "4", - "value_index": 987 + "option_id": 987, + "product_sku": "xyz789", + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": 4, + "value": CustomizableAreaValue } ``` -### ConfigurableCartItem +### CustomizableAreaValue -An implementation for configurable product cart items. +Defines the price and sku of a product whose page contains a customized text area. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": true, - "max_qty": 123.45, - "min_qty": 123.45, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "max_characters": 123, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "uid": 4 } ``` -### ConfigurableOptionAvailableForSelection +### CustomizableCheckboxOption -Describes configurable options that have been selected and can be selected as a result of the previous selections. +Contains information about a set of checkbox values that are defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json { - "attribute_code": "xyz789", - "option_value_uids": [4] + "option_id": 123, + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": [CustomizableCheckboxValue] } ``` -### ConfigurableProduct +### CustomizableCheckboxValue -Defines basic features of a configurable product and its simple product variants. +Defines the price and sku of a product whose page contains a customized set of checkbox values. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | -| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 987, - "configurable_options": [ConfigurableProductOptions], - "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": "abc123", - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 987.65, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, - "reviews": ProductReviews, - "short_description": ComplexTextValue, + "option_type_id": 123, + "price": 987.65, + "price_type": "FIXED", "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "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": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "variants": [ConfigurableVariant], - "websites": [Website], - "weight": 987.65 + "sort_order": 123, + "title": "xyz789", + "uid": 4 } ``` -### ConfigurableProductCartItemInput +### CustomizableDateOption -#### Input Fields +Contains information about a date picker that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | -| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](#string) | Deprecated. Use `CartItemInput.sku` instead. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example ```json { - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "parent_sku": "abc123", - "variant_sku": "abc123" + "option_id": 123, + "product_sku": "abc123", + "required": false, + "sort_order": 987, + "title": "abc123", + "uid": "4", + "value": CustomizableDateValue } ``` -### ConfigurableProductOption +### CustomizableDateTypeEnum -Contains details about configurable product options. +Defines the customizable date type. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](#string) | The display name of the option. | -| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | -| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | +| `DATE` | | +| `DATE_TIME` | | +| `TIME` | | #### Example ```json -{ - "attribute_code": "abc123", - "label": "xyz789", - "uid": "4", - "values": [ConfigurableProductOptionValue] -} +""DATE"" ``` -### ConfigurableProductOptionValue +### CustomizableDateValue -Defines a value for a configurable product option. +Defines the price and sku of a product whose page contains a customized date picker. #### Fields | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](#id) | The unique ID of the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "is_available": true, - "is_use_default": false, - "label": "xyz789", - "swatch": SwatchDataInterface, - "uid": 4 + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "type": "DATE", + "uid": "4" } ``` -### ConfigurableProductOptions +### CustomizableDropDownOption -Defines configurable attributes for the specified product. +Contains information about a drop down menu that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | -| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | #### Example ```json { - "attribute_code": "xyz789", - "attribute_id": "xyz789", - "attribute_id_v2": 123, - "attribute_uid": 4, - "id": 987, - "label": "abc123", - "position": 987, - "product_id": 987, + "option_id": 987, + "required": false, + "sort_order": 123, + "title": "abc123", "uid": 4, - "use_default": true, - "values": [ConfigurableProductOptionsValues] + "value": [CustomizableDropDownValue] } ``` -### ConfigurableProductOptionsSelection +### CustomizableDropDownValue -Contains metadata corresponding to the selected configurable options. +Defines the price and sku of a product whose page contains a customized drop down menu. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | -| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | -| `variant` - [`SimpleProduct`](#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. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "configurable_options": [ConfigurableProductOption], - "media_gallery": [MediaGalleryInterface], - "options_available_for_selection": [ - ConfigurableOptionAvailableForSelection - ], - "variant": SimpleProduct + "option_type_id": 123, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "abc123", + "uid": "4" } ``` -### ConfigurableProductOptionsValues +### CustomizableFieldOption -Contains the index number assigned to a configurable product option. +Contains information about a text field that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](#string) | The label of the product on the default store. | -| `label` - [`String`](#string) | The label of the product. | -| `store_label` - [`String`](#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "default_label": "xyz789", - "label": "abc123", - "store_label": "xyz789", - "swatch_data": SwatchDataInterface, - "uid": "4", - "use_default_value": true, - "value_index": 987 + "option_id": 987, + "product_sku": "xyz789", + "required": false, + "sort_order": 123, + "title": "xyz789", + "uid": 4, + "value": CustomizableFieldValue } ``` -### ConfigurableRequisitionListItem +### CustomizableFieldValue -Contains details about configurable products added to a requisition list. +Defines the price and sku of a product whose page contains a customized text field. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "configurable_options": [SelectedConfigurableOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, + "max_characters": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", "uid": "4" } ``` -### ConfigurableVariant +### CustomizableFileOption -Contains all the simple product variants of a configurable product. +Contains information about a file picker that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example ```json { - "attributes": [ConfigurableAttributeOption], - "product": SimpleProduct + "option_id": 987, + "product_sku": "xyz789", + "required": true, + "sort_order": 123, + "title": "xyz789", + "uid": "4", + "value": CustomizableFileValue } ``` -### ConfigurableWishlistItem +### CustomizableFileValue -A configurable product wish list item. +Defines the price and sku of a product whose page contains a customized file picker. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `file_extension` - [`String`](#string) | The file extension to accept. | +| `image_size_x` - [`Int`](#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](#int) | The maximum height of an image. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "added_at": "abc123", - "child_sku": "xyz789", - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 + "file_extension": "xyz789", + "image_size_x": 987, + "image_size_y": 123, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", + "uid": "4" } ``` -### ConfirmEmailInput +### CustomizableMultipleOption -Contains details about a customer email address to confirm. +Contains information about a multiselect that is defined as part of a customizable option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example ```json { - "confirmation_key": "abc123", - "email": "xyz789" + "option_id": 123, + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": [CustomizableMultipleValue] } ``` -### ConfirmationStatusEnum +### CustomizableMultipleValue -List of account confirmation statuses. +Defines the price and sku of a product whose page contains a customized multiselect. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACCOUNT_CONFIRMED` | Account confirmed | -| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json -""ACCOUNT_CONFIRMED"" +{ + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "abc123", + "uid": 4 +} ``` -### ContactUsInput +### CustomizableOptionInput + +Defines a customizable option. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](#string) | The email address of the shopper. | -| `name` - [`String!`](#string) | The full name of the shopper. | -| `telephone` - [`String`](#string) | The shopper's telephone number. | +| `id` - [`Int`](#int) | The customizable option ID of the product. | +| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](#string) | The string value of the option. | #### Example ```json { - "comment": "xyz789", - "email": "abc123", - "name": "abc123", - "telephone": "xyz789" + "id": 123, + "uid": 4, + "value_string": "xyz789" } ``` -### ContactUsOutput +### CustomizableOptionInterface -Contains the status of the request. +Contains basic information about a customizable option. It can be implemented by several types of configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | + +#### Possible Types + +| CustomizableOptionInterface Types | +|----------------| +| [`CustomizableAreaOption`](#customizableareaoption) | +| [`CustomizableDateOption`](#customizabledateoption) | +| [`CustomizableDropDownOption`](#customizabledropdownoption) | +| [`CustomizableMultipleOption`](#customizablemultipleoption) | +| [`CustomizableFieldOption`](#customizablefieldoption) | +| [`CustomizableFileOption`](#customizablefileoption) | +| [`CustomizableRadioOption`](#customizableradiooption) | +| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | #### Example ```json -{"status": false} +{ + "option_id": 123, + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": "4" +} ``` -### CopyItemsBetweenRequisitionListsInput +### CustomizableProductInterface -An input object that defines the items in a requisition list to be copied. +Contains information about customizable product options. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| Field Name | Description | +|------------|-------------| +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | + +#### Possible Types + +| CustomizableProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | #### Example ```json -{"requisitionListItemUids": ["4"]} +{"options": [CustomizableOptionInterface]} ``` -### CopyItemsFromRequisitionListsOutput +### CustomizableRadioOption -Output of the request to copy items to the destination requisition list. +Contains information about a set of radio buttons that are defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "option_id": 123, + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": [CustomizableRadioValue] +} ``` -### CopyProductsBetweenWishlistsOutput +### CustomizableRadioValue -Contains the source and target wish lists after copying products. +Defines the price and sku of a product whose page contains a customized set of radio buttons. #### Fields | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 123, + "title": "abc123", + "uid": 4 } ``` -### Country +### DeleteCompanyRoleOutput + +Contains the response to the request to delete the company role. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | + +#### Example + +```json +{"success": true} +``` + + + +### DeleteCompanyTeamOutput + +Contains the status of the request to delete a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | + +#### Example + +```json +{"success": false} +``` + + + +### DeleteCompanyUserOutput + +Contains the response to the request to delete the company user. #### Fields | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](#string) | The name of the country in English. | -| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | -| `id` - [`String`](#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | +| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{ - "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "abc123", - "id": "abc123", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" -} +{"success": true} ``` -### CountryCodeEnum +### DeleteCompareListOutput -The list of country codes. +Contains the results of the request to delete a compare list. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `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 &amp; 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 | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | + +#### Example + +```json +{"result": true} +``` + + + +### DeleteNegotiableQuoteError + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | #### Example ```json -""AF"" +NegotiableQuoteInvalidStateError ``` -### CreateCompanyOutput +### DeleteNegotiableQuoteOperationFailure -Contains the response to the request to create a company. +Contains details about a failed delete operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The new company instance. | +| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"company": Company} +{ + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": 4 +} ``` -### CreateCompanyRoleOutput +### DeleteNegotiableQuoteOperationResult -Contains the response to the request to create a company role. +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | + +#### Example + +```json +NegotiableQuoteUidOperationSuccess +``` + + + +### DeleteNegotiableQuoteTemplateInput + +Specifies the quote template id of the quote template to delete + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": "4"} +``` + + + +### DeleteNegotiableQuotesInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | + +#### Example + +```json +{"quote_uids": ["4"]} +``` + + + +### DeleteNegotiableQuotesOutput + +Contains a list of undeleted negotiable quotes the company user can view. #### Fields | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example ```json -{"role": CompanyRole} +{ + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" +} ``` -### CreateCompanyTeamOutput +### DeletePaymentTokenOutput -Contains the response to the request to create a company team. +Indicates whether the request succeeded and returns the remaining customer payment tokens. #### Fields | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | +| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | #### Example ```json -{"team": CompanyTeam} +{ + "customerPaymentTokens": CustomerPaymentTokens, + "result": true +} ``` -### CreateCompanyUserOutput +### DeletePurchaseOrderApprovalRuleError -Contains the response to the request to create a company user. +Contains details about an error that occurred when deleting an approval rule . #### Fields | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The new company user instance. | +| `message` - [`String`](#string) | The text of the error message. | +| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"user": Customer} +{"message": "abc123", "type": "UNDEFINED"} ``` -### CreateCompareListInput +### DeletePurchaseOrderApprovalRuleErrorType -Contains an array of product IDs to use for creating a compare list. +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNDEFINED` | | +| `NOT_FOUND` | | + +#### Example + +```json +""UNDEFINED"" +``` + + + +### DeletePurchaseOrderApprovalRuleInput + +Specifies the IDs of the approval rules to delete. #### Input Fields | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | #### Example ```json -{"products": ["4"]} +{"approval_rule_uids": ["4"]} ``` -### CreateGiftRegistryInput +### DeletePurchaseOrderApprovalRuleOutput -Defines a new gift registry. +Contains any errors encountered while attempting to delete approval rules. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | -| `message` - [`String!`](#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| Field Name | Description | +|------------|-------------| +| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | #### Example ```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "abc123", - "gift_registry_type_uid": 4, - "message": "abc123", - "privacy_settings": "PRIVATE", - "registrants": [AddGiftRegistryRegistrantInput], - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" -} +{"errors": [DeletePurchaseOrderApprovalRuleError]} ``` -### CreateGiftRegistryOutput +### DeleteRequisitionListItemsOutput -Contains the results of a request to create a gift registry. +Output of the request to remove items from the requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | #### Example ```json -{"gift_registry": GiftRegistry} +{"requisition_list": RequisitionList} ``` -### CreateGuestCartInput +### DeleteRequisitionListOutput -#### Input Fields +Indicates whether the request to delete the requisition list was successful. -| Input Field | Description | -|-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{"cart_uid": "4"} +{"requisition_lists": RequisitionLists, "status": false} ``` -### CreateGuestCartOutput +### DeleteWishlistOutput + +Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The newly created cart. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"cart": Cart} +{"status": false, "wishlists": [Wishlist]} ``` -### CreatePayflowProTokenOutput +### Discount -Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. +Specifies the discount type and value for quote line item. #### Fields | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | +| `amount` - [`Money!`](#money) | The amount of the discount. | +| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | +| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](#string) | A description of the discount. | +| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](#float) | Quote line item discount value. | #### Example ```json { - "response_message": "abc123", - "result": 123, - "result_code": 987, - "secure_token": "abc123", - "secure_token_id": "abc123" + "amount": Money, + "applied_to": "ITEM", + "coupon": AppliedCoupon, + "is_discounting_locked": true, + "label": "xyz789", + "type": "abc123", + "value": 123.45 } ``` -### CreatePaymentOrderInput +### DownloadableCartItem -Contains payment order details that are used while processing the payment order +An implementation for downloadable product cart items. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "cartId": "xyz789", - "location": "PRODUCT_DETAIL", - "methodCode": "abc123", - "paymentSource": "xyz789", - "vaultIntent": false + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "id": "abc123", + "is_available": false, + "links": [DownloadableProductLinks], + "max_qty": 123.45, + "min_qty": 987.65, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "samples": [DownloadableProductSamples], + "uid": "4" } ``` -### CreatePaymentOrderOutput +### DownloadableCreditMemoItem -Contains payment order details that are used while processing the payment order +Defines downloadable product options for `CreditMemoItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](#float) | The amount of the payment order | -| `currency_code` - [`String`](#string) | The currency of the payment order | -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `status` - [`String`](#string) | The status of the payment order | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json { - "amount": 123.45, - "currency_code": "xyz789", - "id": "xyz789", - "mp_order_id": "xyz789", - "status": "xyz789" + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` -### CreateProductReviewInput +### DownloadableFileTypeEnum -Defines a new product review. +#### Values -#### Input Fields +| Enum Value | Description | +|------------|-------------| +| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| Input Field | Description | -|-------------|-------------| -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | +#### Example + +```json +""FILE"" +``` + + + +### DownloadableInvoiceItem + +Defines downloadable product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example ```json { - "nickname": "abc123", - "ratings": [ProductReviewRatingInput], - "sku": "abc123", - "summary": "xyz789", - "text": "abc123" + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 123.45 } ``` -### CreateProductReviewOutput +### DownloadableItemsLinks -Contains the completed product review. +Defines characteristics of the links for downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json -{"review": ProductReview} +{ + "sort_order": 123, + "title": "abc123", + "uid": "4" +} ``` -### CreatePurchaseOrderApprovalRuleConditionAmountInput +### DownloadableOrderItem -Specifies the amount and currency to evaluate. +Defines downloadable product options for `OrderItemInterface`. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json -{"currency": "AFN", "value": 123.45} +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "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": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "xyz789" +} ``` -### CreatePurchaseOrderApprovalRuleConditionInput +### DownloadableProduct -Defines a set of conditions that apply to a rule. +Defines a product that the shopper downloads. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | -| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | +| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example ```json { - "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN", - "quantity": 987 + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "downloadable_product_links": [ + DownloadableProductLinks + ], + "downloadable_product_samples": [ + DownloadableProductSamples + ], + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "links_purchased_separately": 987, + "links_title": "abc123", + "manufacturer": 123, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 987.65, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "abc123", + "staged": false, + "stock_status": "IN_STOCK", + "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": "abc123", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website] } ``` -### CreateRequisitionListInput +### DownloadableProductCartItemInput -An input object that identifies and describes a new requisition list. +Defines a single downloadable product. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | +| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | #### Example ```json { - "description": "xyz789", - "name": "abc123" + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "downloadable_product_links": [ + DownloadableProductLinksInput + ] } ``` -### CreateRequisitionListOutput +### DownloadableProductLinks -Output of the request to create a requisition list. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](#float) | The price of the downloadable product. | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "id": 123, + "is_shareable": false, + "link_type": "FILE", + "number_of_downloads": 987, + "price": 123.45, + "sample_file": "xyz789", + "sample_type": "FILE", + "sample_url": "xyz789", + "sort_order": 987, + "title": "xyz789", + "uid": "4" +} ``` -### CreateWishlistInput +### DownloadableProductLinksInput -Defines the name and visibility of a new wish list. +Contains the link ID for the downloadable product. #### Input Fields | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | #### Example ```json -{"name": "abc123", "visibility": "PUBLIC"} +{"link_id": 987} ``` -### CreateWishlistOutput +### DownloadableProductSamples -Contains the wish list. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | - -#### Example - -```json -{"wishlist": Wishlist} -``` - - - -### CreditCardDetailsInput - -Required fields for Payflow Pro and Payments Pro credit card payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](#string) | The credit card type. | +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the sample. | #### Example ```json { - "cc_exp_month": 123, - "cc_exp_year": 987, - "cc_last_4": 987, - "cc_type": "xyz789" + "id": 123, + "sample_file": "abc123", + "sample_type": "FILE", + "sample_url": "xyz789", + "sort_order": 987, + "title": "abc123" } ``` -### CreditMemo +### DownloadableRequisitionListItem -Contains credit memo details. +Contains details about downloadable products added to a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | -| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](#string) | The sequential credit memo number. | -| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json { - "comments": [SalesCommentItem], - "id": 4, - "items": [CreditMemoItemInterface], - "number": "xyz789", - "total": CreditMemoTotal + "customizable_options": [SelectedCustomizableOption], + "links": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples], + "uid": 4 } ``` -### CreditMemoItem +### DownloadableWishlistItem + +A downloadable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "discounts": [Discount], + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "links_v2": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 987.65, + "samples": [DownloadableProductSamples] } ``` -### CreditMemoItemInterface - -Credit memo item details. - -#### Fields +### DuplicateNegotiableQuoteInput -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +Identifies a quote to be duplicated -#### Possible Types +#### Input Fields -| CreditMemoItemInterface Types | -|----------------| -| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | -| [`CreditMemoItem`](#creditmemoitem) | +| Input Field | Description | +|-------------|-------------| +| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | #### Example ```json { - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 + "duplicated_quote_uid": "4", + "quote_uid": 4 } ``` -### CreditMemoTotal +### DuplicateNegotiableQuoteOutput -Contains credit memo price details. +Contains the newly created negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example ```json -{ - "adjustment": Money, - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} +{"quote": NegotiableQuote} ``` -### Currency +### DynamicBlock + +Contains a single dynamic block. #### Fields | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | -| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | +| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | +| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json { - "available_currency_codes": ["xyz789"], - "base_currency_code": "abc123", - "base_currency_symbol": "abc123", - "default_display_currecy_code": "abc123", - "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "abc123", - "exchange_rates": [ExchangeRate] + "content": ComplexTextValue, + "uid": "4" } ``` -### CurrencyEnum - -The list of available currency codes. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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` | | - +### DynamicBlockLocationEnum + +Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CONTENT` | | +| `HEADER` | | +| `FOOTER` | | +| `LEFT` | | +| `RIGHT` | | + #### Example ```json -""AFN"" +""CONTENT"" ``` -### CustomAttributeMetadata +### DynamicBlockTypeEnum -Defines an array of custom attributes. +Indicates the selected Dynamic Blocks Rotator inline widget. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | +| `SPECIFIED` | | +| `CART_PRICE_RULE_RELATED` | | +| `CATALOG_PRICE_RULE_RELATED` | | #### Example ```json -{"items": [Attribute]} +""SPECIFIED"" ``` -### CustomAttributeMetadataInterface +### DynamicBlocks -An interface containing fields that define the EAV attribute. +Contains an array of dynamic blocks. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | -#### Possible Types +#### Example -| CustomAttributeMetadataInterface Types | -|----------------| -| [`AttributeMetadata`](#attributemetadata) | -| [`CatalogAttributeMetadata`](#catalogattributemetadata) | -| [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | +```json +{ + "items": [DynamicBlock], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### DynamicBlocksFilterInput + +Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | +| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | #### Example ```json { - "code": "4", - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_required": true, - "is_unique": true, - "label": "xyz789", - "options": [CustomAttributeOptionInterface] + "dynamic_block_uids": ["4"], + "locations": ["CONTENT"], + "type": "SPECIFIED" } ``` -### CustomAttributeOptionInterface +### EnteredCustomAttributeInput + +Contains details about a custom text attribute that the buyer entered. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](#string) | The text or other entered value. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "value": "xyz789" +} +``` + + + +### EnteredOptionInput + +Defines a customer-entered option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](#string) | Text the customer entered. | + +#### Example + +```json +{ + "uid": "4", + "value": "abc123" +} +``` + + + +### EntityUrl + +Contains the `uid`, `relative_url`, and `type` attributes. #### Fields | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | +| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | +| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Example + +```json +{ + "canonical_url": "xyz789", + "entity_uid": 4, + "id": 987, + "redirectCode": 987, + "relative_url": "abc123", + "type": "CMS_PAGE" +} +``` + + + +### ErrorInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | #### Possible Types -| CustomAttributeOptionInterface Types | +| ErrorInterface Types | |----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | + +#### Example + +```json +{"message": "abc123"} +``` + + + +### EstimateAddressInput + +Contains details about an address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example ```json { - "is_default": true, - "label": "xyz789", - "value": "xyz789" + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput } ``` -### Customer +### EstimateTotalsInput -Defines the customer name, addresses, and other details. +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | +| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | + +#### Example + +```json +{ + "address": EstimateAddressInput, + "cart_id": "xyz789", + "shipping_method": ShippingMethodInput +} +``` + + + +### EstimateTotalsOutput + +Estimate totals output. #### Fields | Field Name | Description | |------------|-------------| -| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | -| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](#string) | The customer's email address. Required. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | -| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`Int`](#int) | The ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | -| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | -| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | -| `telephone` - [`String`](#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](#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. | +| `cart` - [`Cart`](#cart) | Cart after totals estimation | #### Example ```json -{ - "addresses": [CustomerAddress], - "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": "abc123", - "dob": "xyz789", - "email": "abc123", - "firstname": "xyz789", - "gender": 987, - "gift_registries": [GiftRegistry], - "gift_registry": GiftRegistry, - "group_id": 987, - "id": 123, - "is_subscribed": true, - "job_title": "abc123", - "lastname": "abc123", - "middlename": "abc123", - "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, - "status": "ACTIVE", - "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "xyz789", - "taxvat": "xyz789", - "team": CompanyTeam, - "telephone": "abc123", - "wishlist": Wishlist, - "wishlist_v2": Wishlist, - "wishlists": [Wishlist] -} +{"cart": Cart} +``` + + + +### ExchangeRate + +Lists the exchange rate. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | + +#### Example + +```json +{"currency_to": "abc123", "rate": 987.65} ``` + +### createEmptyCartInput + +Assigns a specific `cart_id` to the empty cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String`](#string) | The ID to assign to the cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md new file mode 100644 index 000000000..69c6b6838 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md @@ -0,0 +1,2341 @@ +## Types + +### FilterEqualTypeInput + +Defines a filter that matches the input exactly. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#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]`](#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 + +```json +{ + "eq": "abc123", + "in": ["xyz789"] +} +``` + + + +### FilterMatchTypeEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FULL` | | +| `PARTIAL` | | + +#### Example + +```json +""FULL"" +``` + + + +### FilterMatchTypeInput + +Defines a filter that performs a fuzzy search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `match` - [`String`](#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`](#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 + +```json +{"match": "abc123", "match_type": "FULL"} +``` + + + +### FilterRangeTypeInput + +Defines a filter that matches a range of values, such as prices or dates. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | + +#### Example + +```json +{ + "from": "xyz789", + "to": "xyz789" +} +``` + + + +### FilterStringTypeInput + +Defines a filter for an input string. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | + +#### Example + +```json +{ + "eq": "abc123", + "in": ["xyz789"], + "match": "xyz789" +} +``` + + + +### FilterTypeInput + +Defines the comparison operators that can be used in a filter. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Equals. | +| `finset` - [`[String]`](#string) | | +| `from` - [`String`](#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](#string) | Greater than. | +| `gteq` - [`String`](#string) | Greater than or equal to. | +| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](#string) | Less than. | +| `lteq` - [`String`](#string) | Less than or equal to. | +| `moreq` - [`String`](#string) | More than or equal to. | +| `neq` - [`String`](#string) | Not equal to. | +| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](#string) | Not null. | +| `null` - [`String`](#string) | Is null. | +| `to` - [`String`](#string) | To. Must be used with the `from` field. | + +#### Example + +```json +{ + "eq": "abc123", + "finset": ["abc123"], + "from": "abc123", + "gt": "abc123", + "gteq": "abc123", + "in": ["abc123"], + "like": "abc123", + "lt": "abc123", + "lteq": "xyz789", + "moreq": "xyz789", + "neq": "xyz789", + "nin": ["abc123"], + "notnull": "abc123", + "null": "xyz789", + "to": "abc123" +} +``` + + + +### FixedProductTax + +A single FPT that can be applied to a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | + +#### Example + +```json +{ + "amount": Money, + "label": "xyz789" +} +``` + + + +### FixedProductTaxDisplaySettings + +Lists display settings for the Fixed Product Tax. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""INCLUDE_FPT_WITHOUT_DETAILS"" +``` + + + +### Float + +The `Float` scalar type represents signed double-precision fractional +values as specified by +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). + +#### Example + +```json +123.45 +``` + + + +### GenerateCustomerTokenAsAdminInput + +Identifies which customer requires remote shopping assistance. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | + +#### Example + +```json +{"customer_email": "xyz789"} +``` + + + +### GenerateCustomerTokenAsAdminOutput + +Contains the generated customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer_token` - [`String!`](#string) | The generated customer token. | + +#### Example + +```json +{"customer_token": "abc123"} +``` + + + +### GenerateNegotiableQuoteFromTemplateInput + +Specifies the template id, from which to generate quote from. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": "4"} +``` + + + +### GenerateNegotiableQuoteFromTemplateOutput + +Contains the generated negotiable quote id. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | + +#### Example + +```json +{"negotiable_quote_uid": "4"} +``` + + + +### GetPaymentSDKOutput + +Gets the payment SDK URLs and values + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | + +#### Example + +```json +{"sdkParams": [PaymentSDKParamsItem]} +``` + + + +### GiftCardAccount + +Contains details about the gift card account. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`Money`](#money) | The balance remaining on the gift card. | +| `code` - [`String`](#string) | The gift card account code. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "balance": Money, + "code": "abc123", + "expiration_date": "abc123" +} +``` + + + +### GiftCardAccountInput + +Contains the gift card code. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_card_code` - [`String!`](#string) | The applied gift card code. | + +#### Example + +```json +{"gift_card_code": "xyz789"} +``` + + + +### GiftCardAmounts + +Contains the value of a gift card, the website that generated the card, and related information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_id` - [`Int`](#int) | An internal attribute ID. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | +| `value` - [`Float`](#float) | The value of the gift card. | +| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | +| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | +| `website_value` - [`Float`](#float) | The value of the gift card. | + +#### Example + +```json +{ + "attribute_id": 987, + "uid": 4, + "value": 987.65, + "value_id": 987, + "website_id": 987, + "website_value": 123.45 +} +``` + + + +### GiftCardCartItem + +Contains details about a gift card that has been added to a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender. | +| `sender_name` - [`String!`](#string) | The name of the sender. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "amount": Money, + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "id": "xyz789", + "is_available": false, + "max_qty": 987.65, + "message": "xyz789", + "min_qty": 123.45, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "recipient_email": "abc123", + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "abc123", + "uid": "4" +} +``` + + + +### GiftCardCreditMemoItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 123.45 +} +``` + + + +### GiftCardInvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 123.45 +} +``` + + + +### GiftCardItem + +Contains details about a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | + +#### Example + +```json +{ + "message": "abc123", + "recipient_email": "abc123", + "recipient_name": "abc123", + "sender_email": "abc123", + "sender_name": "xyz789" +} +``` + + + +### GiftCardOptions + +Contains details about the sender, recipient, and amount of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](#string) | A message to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | + +#### Example + +```json +{ + "amount": Money, + "custom_giftcard_amount": Money, + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "abc123" +} +``` + + + +### GiftCardOrderItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_card": GiftCardItem, + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "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": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} +``` + + + +### GiftCardProduct + +Defines properties of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | +| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | +| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "allow_message": false, + "allow_open_amount": true, + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_card_options": [CustomizableOptionInterface], + "gift_message_available": "xyz789", + "giftcard_amounts": [GiftCardAmounts], + "giftcard_type": "VIRTUAL", + "id": 123, + "image": ProductImage, + "is_redeemable": false, + "is_returnable": "xyz789", + "lifetime": 123, + "manufacturer": 987, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "message_max_length": 987, + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "open_amount_max": 123.45, + "open_amount_min": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 987.65, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "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": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### GiftCardRequisitionListItem + +Contains details about gift cards added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "gift_card_options": GiftCardOptions, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### GiftCardShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 123.45 +} +``` + + + +### GiftCardTypeEnum + +Specifies the gift card type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `VIRTUAL` | | +| `PHYSICAL` | | +| `COMBINED` | | + +#### Example + +```json +""VIRTUAL"" +``` + + + +### GiftCardWishlistItem + +A single gift card added to a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "gift_card_options": GiftCardOptions, + "id": 4, + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### GiftMessage + +Contains the text of a gift message, its sender, and recipient + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `from` - [`String!`](#string) | Sender name | +| `message` - [`String!`](#string) | Gift message text | +| `to` - [`String!`](#string) | Recipient name | + +#### Example + +```json +{ + "from": "abc123", + "message": "xyz789", + "to": "abc123" +} +``` + + + +### GiftMessageInput + +Defines a gift message. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String!`](#string) | The name of the sender. | +| `message` - [`String!`](#string) | The text of the gift message. | +| `to` - [`String!`](#string) | The name of the recepient. | + +#### Example + +```json +{ + "from": "xyz789", + "message": "abc123", + "to": "abc123" +} +``` + + + +### GiftOptionsPrices + +Contains prices for gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | +| `printed_card` - [`Money`](#money) | Price for the printed card. | + +#### Example + +```json +{ + "gift_wrapping_for_items": Money, + "gift_wrapping_for_order": Money, + "printed_card": Money +} +``` + + + +### GiftRegistry + +Contains details about a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | +| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | +| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | +| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | +| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | + +#### Example + +```json +{ + "created_at": "xyz789", + "dynamic_attributes": [GiftRegistryDynamicAttribute], + "event_name": "xyz789", + "items": [GiftRegistryItemInterface], + "message": "xyz789", + "owner_name": "xyz789", + "privacy_settings": "PRIVATE", + "registrants": [GiftRegistryRegistrant], + "shipping_address": CustomerAddress, + "status": "ACTIVE", + "type": GiftRegistryType, + "uid": 4 +} +``` + + + +### GiftRegistryDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": "4", + "group": "EVENT_INFORMATION", + "label": "xyz789", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeGroup + +Defines the group type of a gift registry dynamic attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `EVENT_INFORMATION` | | +| `PRIVACY_SETTINGS` | | +| `REGISTRANT` | | +| `GENERAL_INFORMATION` | | +| `DETAILED_INFORMATION` | | +| `SHIPPING_ADDRESS` | | + +#### Example + +```json +""EVENT_INFORMATION"" +``` + + + +### GiftRegistryDynamicAttributeInput + +Defines a dynamic attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | +| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | + +#### Example + +```json +{"code": 4, "value": "abc123"} +``` + + + +### GiftRegistryDynamicAttributeInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Possible Types + +| GiftRegistryDynamicAttributeInterface Types | +|----------------| +| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | +| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | + +#### Example + +```json +{ + "code": "4", + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### GiftRegistryDynamicAttributeMetadata + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Example + +```json +{ + "attribute_group": "abc123", + "code": "4", + "input_type": "xyz789", + "is_required": false, + "label": "xyz789", + "sort_order": 123 +} +``` + + + +### GiftRegistryDynamicAttributeMetadataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Possible Types + +| GiftRegistryDynamicAttributeMetadataInterface Types | +|----------------| +| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | + +#### Example + +```json +{ + "attribute_group": "xyz789", + "code": "4", + "input_type": "xyz789", + "is_required": false, + "label": "xyz789", + "sort_order": 123 +} +``` + + + +### GiftRegistryItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "xyz789", + "product": ProductInterface, + "quantity": 123.45, + "quantity_fulfilled": 123.45, + "uid": 4 +} +``` + + + +### GiftRegistryItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Possible Types + +| GiftRegistryItemInterface Types | +|----------------| +| [`GiftRegistryItem`](#giftregistryitem) | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "abc123", + "product": ProductInterface, + "quantity": 123.45, + "quantity_fulfilled": 123.45, + "uid": "4" +} +``` + + + +### GiftRegistryItemUserErrorInterface + +Contains the status and any errors that encountered with the customer's gift register item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | + +#### Possible Types + +| GiftRegistryItemUserErrorInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{ + "status": true, + "user_errors": [GiftRegistryItemsUserError] +} +``` + + + +### GiftRegistryItemsUserError + +Contains details about an error that occurred when processing a gift registry item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | +| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | +| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | +| `message` - [`String!`](#string) | A localized error message. | +| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | + +#### Example + +```json +{ + "code": "OUT_OF_STOCK", + "gift_registry_item_uid": "4", + "gift_registry_uid": 4, + "message": "xyz789", + "product_uid": "4" +} +``` + + + +### GiftRegistryItemsUserErrorType + +Defines the error type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""OUT_OF_STOCK"" +``` + + + +### GiftRegistryOutputInterface + +Contains the customer's gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | + +#### Possible Types + +| GiftRegistryOutputInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### GiftRegistryPrivacySettings + +Defines the privacy setting of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRIVATE` | | +| `PUBLIC` | | + +#### Example + +```json +""PRIVATE"" +``` + + + +### GiftRegistryRegistrant + +Contains details about a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | +| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryRegistrantDynamicAttribute + ], + "email": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "uid": 4 +} +``` + + + +### GiftRegistryRegistrantDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": 4, + "label": "abc123", + "value": "abc123" +} +``` + + + +### GiftRegistrySearchResult + +Contains the results of a gift registry search. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `event_date` - [`String`](#string) | The date of the event. | +| `event_title` - [`String!`](#string) | The title given to the event. | +| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | +| `location` - [`String`](#string) | The location of the event. | +| `name` - [`String!`](#string) | The name of the gift registry owner. | +| `type` - [`String`](#string) | The type of event being held. | + +#### Example + +```json +{ + "event_date": "xyz789", + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "xyz789", + "name": "xyz789", + "type": "xyz789" +} +``` + + + +### GiftRegistryShippingAddressInput + +Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | + +#### Example + +```json +{"address_data": CustomerAddressInput, "address_id": 4} +``` + + + +### GiftRegistryStatus + +Defines the status of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | + +#### Example + +```json +""ACTIVE"" +``` + + + +### GiftRegistryType + +Contains details about a gift registry type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | + +#### Example + +```json +{ + "dynamic_attributes_metadata": [ + GiftRegistryDynamicAttributeMetadataInterface + ], + "label": "xyz789", + "uid": "4" +} +``` + + + +### GiftWrapping + +Contains details about the selected or available gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | +| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | +| `price` - [`Money!`](#money) | The gift wrapping price. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | + +#### Example + +```json +{ + "design": "abc123", + "id": 4, + "image": GiftWrappingImage, + "price": Money, + "uid": "4" +} +``` + + + +### GiftWrappingImage + +Points to an image associated with a gift wrapping option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The gift wrapping preview image label. | +| `url` - [`String!`](#string) | The gift wrapping preview image URL. | + +#### Example + +```json +{ + "label": "xyz789", + "url": "abc123" +} +``` + + + +### GooglePayButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `type` - [`String`](#string) | The button type | + +#### Example + +```json +{ + "color": "abc123", + "height": 987, + "type": "abc123" +} +``` + + + +### GooglePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": GooglePayButtonStyles, + "code": "abc123", + "is_visible": false, + "payment_intent": "xyz789", + "payment_source": "abc123", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "title": "abc123" +} +``` + + + +### GooglePayMethodInput + +Google Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" +} +``` + + + +### GroupedProduct + +Defines a grouped product, which consists of simple standalone products that are presented as a group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "items": [GroupedProductItem], + "manufacturer": 987, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options_container": "abc123", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 987.65, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "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": "xyz789", + "websites": [Website], + "weight": 123.45 +} +``` + + + +### GroupedProductItem + +Contains information about an individual grouped product item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | +| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | +| `qty` - [`Float`](#float) | The quantity of this grouped product item. | + +#### Example + +```json +{ + "position": 123, + "product": ProductInterface, + "qty": 987.65 +} +``` + + + +### GroupedProductWishlistItem + +A grouped product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### HostedFieldsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cc_vault_code` - [`String`](#string) | Vault payment method code | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](#boolean) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "cc_vault_code": "xyz789", + "code": "xyz789", + "is_vault_enabled": true, + "is_visible": true, + "payment_intent": "abc123", + "payment_source": "xyz789", + "requires_card_details": true, + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "three_ds": true, + "title": "abc123" +} +``` + + + +### HostedFieldsInput + +Hosted Fields payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cardBin` - [`String`](#string) | Card bin number | +| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | +| `cardLast4` - [`String`](#string) | Last four digits of the card | +| `holderName` - [`String`](#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cardBin": "xyz789", + "cardExpiryMonth": "xyz789", + "cardExpiryYear": "xyz789", + "cardLast4": "xyz789", + "holderName": "abc123", + "is_active_payment_token_enabler": false, + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### HostedProInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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 + +```json +{ + "cancel_url": "xyz789", + "return_url": "xyz789" +} +``` + + + +### HostedProUrl + +Contains the secure URL used for the Payments Pro Hosted Solution payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | + +#### Example + +```json +{"secure_form_url": "xyz789"} +``` + + + +### HostedProUrlInput + +Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### HttpQueryParameter + +Contains target path parameters. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | A parameter name. | +| `value` - [`String`](#string) | A parameter value. | + +#### Example + +```json +{ + "name": "xyz789", + "value": "xyz789" +} +``` + + + +### ID + +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 + +```json +"4" +``` + + + +### ImageSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{ + "thumbnail": "abc123", + "value": "xyz789" +} +``` + + + +### InputFilterEnum + +List of templates/filters applied to customer attribute input. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""NONE"" +``` + + + +### Int + +The `Int` scalar type represents non-fractional signed whole numeric +values. Int can represent values between -(2^31) and 2^31 - 1. + +#### Example + +```json +123 +``` + + + +### InternalError + +Contains an error message when an internal error occurred. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | + +#### Example + +```json +{"message": "abc123"} +``` + + + +### Invoice + +Contains invoice details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | +| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | +| `number` - [`String!`](#string) | Sequential invoice number. | +| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "id": 4, + "items": [InvoiceItemInterface], + "number": "xyz789", + "total": InvoiceTotal +} +``` + + + +### InvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### InvoiceItemInterface + +Contains detailes about invoiced items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Possible Types + +| InvoiceItemInterface Types | +|----------------| +| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | +| [`InvoiceItem`](#invoiceitem) | + +#### Example + +```json +{ + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### InvoiceTotal + +Contains price details from an invoice. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | + +#### Example + +```json +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money +} +``` + + + +### IsCompanyAdminEmailAvailableOutput + +Contains the response of a company admin email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsCompanyEmailAvailableOutput + +Contains the response of a company email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsCompanyRoleNameAvailableOutput + +Contains the response of a role name validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | + +#### Example + +```json +{"is_role_name_available": false} +``` + + + +### IsCompanyUserEmailAvailableOutput + +Contains the response of a company user email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsEmailAvailableOutput + +Contains the result of the `isEmailAvailable` query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### ItemNote + +The note object for quote line item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | +| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | +| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | +| `note` - [`String`](#string) | Note text. | +| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | + +#### Example + +```json +{ + "created_at": "xyz789", + "creator_id": 987, + "creator_type": 123, + "negotiable_quote_item_uid": "4", + "note": "xyz789", + "note_uid": 4 +} +``` + + + +### ItemSelectedBundleOption + +A list of options of the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String!`](#string) | The label of the option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | +| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | + +#### Example + +```json +{ + "id": 4, + "label": "abc123", + "uid": 4, + "values": [ItemSelectedBundleOptionValue] +} +``` + + + +### ItemSelectedBundleOptionValue + +A list of values for the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | +| `price` - [`Money!`](#money) | The price of the child bundle product. | +| `product_name` - [`String!`](#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | +| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | + +#### Example + +```json +{ + "id": 4, + "price": Money, + "product_name": "xyz789", + "product_sku": "abc123", + "quantity": 987.65, + "uid": "4" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-3.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md similarity index 52% rename from src/pages/includes/autogenerated/graphql-api-2-4-7-types-3.md rename to src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md index f7a7a8942..33ee7860d 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-3.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-k-p.md @@ -1,6071 +1,4351 @@ -### OrderItem +## Types + +### KeyValue + +Contains a key-value pair. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `name` - [`String`](#string) | The name part of the key/value pair. | +| `value` - [`String`](#string) | The value part of the key/value pair. | #### Example ```json { - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "product": ProductInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "abc123" + "name": "abc123", + "value": "xyz789" } ``` -### OrderItemInterface +### LayerFilter -Order item details. +Contains information for rendering layered navigation. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Possible Types - -| OrderItemInterface Types | -|----------------| -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | -| [`OrderItem`](#orderitem) | +| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | +| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example ```json { - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "4", - "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": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" + "filter_items": [LayerFilterItemInterface], + "filter_items_count": 123, + "name": "abc123", + "request_var": "abc123" } ``` -### OrderItemOption - -Represents order item options like selected or entered. +### LayerFilterItem #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example ```json { - "label": "abc123", - "value": "xyz789" + "items_count": 123, + "label": "xyz789", + "value_string": "abc123" } ``` -### OrderPaymentMethod - -Contains details about the payment method used to pay for the order. +### LayerFilterItemInterface #### Fields | Field Name | Description | |------------|-------------| -| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](#string) | The label that describes the payment method. | -| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Possible Types + +| LayerFilterItemInterface Types | +|----------------| +| [`LayerFilterItem`](#layerfilteritem) | +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | #### Example ```json { - "additional_data": [KeyValue], - "name": "abc123", - "type": "abc123" + "items_count": 987, + "label": "xyz789", + "value_string": "xyz789" } ``` -### OrderShipment +### LineItemNoteInput -Contains order shipment details. +Sets quote item note. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | +| Input Field | Description | +|-------------|-------------| +| `note` - [`String`](#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "comments": [SalesCommentItem], - "id": 4, - "items": [ShipmentItemInterface], - "number": "xyz789", - "tracking": [ShipmentTracking] + "note": "xyz789", + "quote_item_uid": 4, + "quote_uid": 4 } ``` -### OrderTokenInput +### MediaGalleryEntry -Input to retrieve an order based on token. +Defines characteristics about images and videos associated with a specific product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `token` - [`String!`](#string) | Order token. | +| Field Name | Description | +|------------|-------------| +| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](#string) | The path of the image on the server. | +| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](#string) | Either `image` or `video`. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example ```json -{"token": "abc123"} +{ + "content": ProductMediaGalleryEntriesContent, + "disabled": false, + "file": "abc123", + "id": 987, + "label": "xyz789", + "media_type": "abc123", + "position": 987, + "types": ["xyz789"], + "uid": "4", + "video_content": ProductMediaGalleryEntriesVideoContent +} ``` -### OrderTotal +### MediaGalleryInterface -Contains details about the sales total amounts used to calculate the final price. +Contains basic information about a product image or video. #### Fields | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | -| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | -| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Possible Types + +| MediaGalleryInterface Types | +|----------------| +| [`ProductImage`](#productimage) | +| [`ProductVideo`](#productvideo) | #### Example ```json { - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_giftcard": Money, - "total_shipping": Money, - "total_tax": Money + "disabled": false, + "label": "abc123", + "position": 987, + "url": "abc123" } ``` -### PayflowExpressInput - -Contains required input for Payflow Express Checkout payments. +### MessageStyleLogo -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | +| Field Name | Description | +|------------|-------------| +| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{ - "payer_id": "xyz789", - "token": "xyz789" -} +{"type": "xyz789"} ``` -### PayflowLinkInput - -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. +### MessageStyles -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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. | +| Field Name | Description | +|------------|-------------| +| `layout` - [`String`](#string) | The message layout | +| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "cancel_url": "abc123", - "error_url": "xyz789", - "return_url": "xyz789" + "layout": "xyz789", + "logo": MessageStyleLogo } ``` -### PayflowLinkMode +### Money -Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. +Defines a monetary value, including a numeric value and a currency code. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `TEST` | | -| `LIVE` | | +| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](#float) | A number expressing a monetary value. | #### Example ```json -""TEST"" +{"currency": "AFN", "value": 987.65} ``` -### PayflowLinkToken +### MoveCartItemsToGiftRegistryOutput -Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. +Contains the customer's gift registry and any errors encountered. #### Fields | Field Name | Description | |------------|-------------| -| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example ```json { - "mode": "TEST", - "paypal_url": "abc123", - "secure_token": "xyz789", - "secure_token_id": "abc123" + "gift_registry": GiftRegistry, + "status": true, + "user_errors": [GiftRegistryItemsUserError] } ``` -### PayflowLinkTokenInput +### MoveItemsBetweenRequisitionListsInput -Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. +An input object that defines the items in a requisition list to be moved. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{"cart_id": "abc123"} +{"requisitionListItemUids": [4]} ``` -### PayflowProInput +### MoveItemsBetweenRequisitionListsOutput -Contains input for the Payflow Pro and Payments Pro payment methods. +Output of the request to move items to another requisition list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](#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. | +| Field Name | Description | +|------------|-------------| +| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | #### Example ```json { - "cc_details": CreditCardDetailsInput, - "is_active_payment_token_enabler": false + "destination_requisition_list": RequisitionList, + "source_requisition_list": RequisitionList } ``` -### PayflowProResponseInput +### MoveLineItemToRequisitionListInput -Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. +Move Line Item to Requisition List. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | #### Example ```json { - "cart_id": "xyz789", - "paypal_payload": "xyz789" + "quote_item_uid": 4, + "quote_uid": "4", + "requisition_list_uid": 4 } ``` -### PayflowProResponseOutput +### MoveLineItemToRequisitionListOutput + +Contains the updated negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | #### Example ```json -{"cart": Cart} +{"quote": NegotiableQuote} ``` -### PayflowProTokenInput +### MoveProductsBetweenWishlistsOutput -Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. +Contains the source and target wish lists after moving products. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | +| Field Name | Description | +|------------|-------------| +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example ```json { - "cart_id": "xyz789", - "urls": PayflowProUrlInput + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] } ``` -### PayflowProUrlInput +### NegotiableQuote -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. +Contains details about a negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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. | +| Field Name | Description | +|------------|-------------| +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](#string) | The email address of the company user. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | +| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | #### Example ```json { - "cancel_url": "abc123", - "error_url": "abc123", - "return_url": "abc123" + "available_payment_methods": [AvailablePaymentMethod], + "billing_address": NegotiableQuoteBillingAddress, + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "created_at": "abc123", + "email": "xyz789", + "history": [NegotiableQuoteHistoryEntry], + "is_virtual": false, + "items": [CartItemInterface], + "name": "abc123", + "prices": CartPrices, + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [NegotiableQuoteShippingAddress], + "status": "SUBMITTED", + "total_quantity": 987.65, + "uid": "4", + "updated_at": "abc123" } ``` -### PaymentConfigItem +### NegotiableQuoteAddressCountry -Contains payment fields that are common to all types of payment methods. +Defines the company's country. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Possible Types - -| PaymentConfigItem Types | -|----------------| -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | -| [`ApplePayConfig`](#applepayconfig) | -| [`GooglePayConfig`](#googlepayconfig) | +| `code` - [`String!`](#string) | The address country code. | +| `label` - [`String!`](#string) | The display name of the region. | #### Example ```json { "code": "abc123", - "is_visible": false, - "payment_intent": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "xyz789" + "label": "xyz789" } ``` -### PaymentConfigOutput +### NegotiableQuoteAddressInput -Retrieves the payment configuration for a given location +Defines the billing or shipping address to be applied to the cart. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | -| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | +| Input Field | Description | +|-------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company name. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | #### Example ```json { - "apple_pay": ApplePayConfig, - "google_pay": GooglePayConfig, - "hosted_fields": HostedFieldsConfig, - "smart_buttons": SmartButtonsConfig + "city": "xyz789", + "company": "xyz789", + "country_code": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "abc123", + "region": "xyz789", + "region_id": 987, + "save_in_address_book": true, + "street": ["abc123"], + "telephone": "xyz789" } ``` -### PaymentLocation - -Defines the origin location for that payment request +### NegotiableQuoteAddressInterface -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `PRODUCT_DETAIL` | | -| `MINICART` | | -| `CART` | | -| `CHECKOUT` | | -| `ADMIN` | | - -#### Example - -```json -""PRODUCT_DETAIL"" -``` +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | - - -### PaymentMethodInput - -Defines the payment method. - -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `braintree` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_ach_direct_debit` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_applepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | -| `braintree_googlepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_paypal` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_paypal_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `code` - [`String!`](#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | -| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | -| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | -| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | -| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | -| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| NegotiableQuoteAddressInterface Types | +|----------------| +| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | +| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | #### Example ```json { - "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": "xyz789", - "hosted_pro": HostedProInput, - "payflow_express": PayflowExpressInput, - "payflow_link": PayflowLinkInput, - "payflowpro": PayflowProInput, - "payflowpro_cc_vault": VaultTokenInput, - "payment_services_paypal_apple_pay": ApplePayMethodInput, - "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": "abc123" + "city": "xyz789", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "xyz789", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "street": ["xyz789"], + "telephone": "xyz789" } ``` -### PaymentOrderOutput +### NegotiableQuoteAddressRegion -Contains the payment order details +Defines the company's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](#string) | The status of the payment order | +| `code` - [`String`](#string) | The address region code. | +| `label` - [`String`](#string) | The display name of the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "id": "xyz789", - "mp_order_id": "xyz789", - "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "code": "xyz789", + "label": "abc123", + "region_id": 123 } ``` -### PaymentSDKParamsItem +### NegotiableQuoteBillingAddress #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | #### Example ```json { - "code": "abc123", - "params": [SDKParams] + "city": "xyz789", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "firstname": "abc123", + "lastname": "xyz789", + "postcode": "xyz789", + "region": NegotiableQuoteAddressRegion, + "street": ["abc123"], + "telephone": "xyz789" } ``` -### PaymentSourceDetails +### NegotiableQuoteBillingAddressInput -#### Fields +Defines the billing address. -| Field Name | Description | -|------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example ```json -{"card": Card} +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "same_as_shipping": true, + "use_for_shipping": true +} ``` -### PaymentToken +### NegotiableQuoteComment -The stored payment method available to the customer. +Contains a single plain text comment from either the buyer or seller. #### Fields | Field Name | Description | |------------|-------------| -| `details` - [`String`](#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](#string) | The public hash of the token. | -| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | +| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | +| `text` - [`String!`](#string) | The plain text comment. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { - "details": "abc123", - "payment_method_code": "xyz789", - "public_hash": "xyz789", - "type": "card" + "author": NegotiableQuoteUser, + "created_at": "xyz789", + "creator_type": "BUYER", + "text": "abc123", + "uid": 4 } ``` -### PaymentTokenTypeEnum - -The list of available payment token types. +### NegotiableQuoteCommentCreatorType #### Values | Enum Value | Description | |------------|-------------| -| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | -| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| `BUYER` | | +| `SELLER` | | #### Example ```json -""card"" +""BUYER"" ``` -### PaypalExpressInput +### NegotiableQuoteCommentInput -Contains required input for Express Checkout and Payments Standard payments. +Contains the commend provided by the buyer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | +| `comment` - [`String!`](#string) | The comment provided by the buyer. | + +#### Example + +```json +{"comment": "xyz789"} +``` + + + +### NegotiableQuoteCustomLogChange + +Contains custom log entries added by third-party extensions. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `new_value` - [`String!`](#string) | The new entry content. | +| `old_value` - [`String`](#string) | The previous entry in the custom log. | +| `title` - [`String!`](#string) | The title of the custom log entry. | #### Example ```json { - "payer_id": "xyz789", - "token": "abc123" + "new_value": "abc123", + "old_value": "abc123", + "title": "abc123" } ``` -### PaypalExpressTokenInput +### NegotiableQuoteFilterInput -Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. +Defines a filter to limit the negotiable quotes to return. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](#string) | The payment method code. | -| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | -| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | -| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example ```json { - "cart_id": "abc123", - "code": "xyz789", - "express_button": false, - "urls": PaypalExpressUrlsInput, - "use_paypal_credit": false + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput } ``` -### PaypalExpressTokenOutput +### NegotiableQuoteHistoryChanges -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. +Contains a list of changes to a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](#string) | The token returned by PayPal. | +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | #### Example ```json { - "paypal_urls": PaypalExpressUrlList, - "token": "abc123" + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange } ``` -### PaypalExpressUrlList +### NegotiableQuoteHistoryCommentChange -Contains a set of URLs that allow the buyer to authorize payment and adjust checkout details for Express Checkout and Payments Standard transactions. +Contains a comment submitted by a seller or buyer. #### Fields | Field Name | Description | |------------|-------------| -| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](#string) | The URL to the PayPal login page. | +| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{ - "edit": "abc123", - "start": "xyz789" -} +{"comment": "abc123"} ``` -### PaypalExpressUrlsInput +### NegotiableQuoteHistoryEntry -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. +Contains details about a change for a negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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. | +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | +| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | +| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example ```json { - "cancel_url": "xyz789", - "pending_url": "xyz789", - "return_url": "xyz789", - "success_url": "abc123" + "author": NegotiableQuoteUser, + "change_type": "CREATED", + "changes": NegotiableQuoteHistoryChanges, + "created_at": "abc123", + "uid": 4 } ``` -### PhysicalProductInterface - -Contains attributes specific to tangible products. +### NegotiableQuoteHistoryEntryChangeType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Possible Types - -| PhysicalProductInterface Types | -|----------------| -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | +| `CREATED` | | +| `UPDATED` | | +| `CLOSED` | | +| `UPDATED_BY_SYSTEM` | | #### Example ```json -{"weight": 123.45} +""CREATED"" ``` -### PickupLocation +### NegotiableQuoteHistoryExpirationChange -Defines Pickup Location information. +Contains a new expiration date and the previous date. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | | -| `contact_name` - [`String`](#string) | | -| `country_id` - [`String`](#string) | | -| `description` - [`String`](#string) | | -| `email` - [`String`](#string) | | -| `fax` - [`String`](#string) | | -| `latitude` - [`Float`](#float) | | -| `longitude` - [`Float`](#float) | | -| `name` - [`String`](#string) | | -| `phone` - [`String`](#string) | | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | | -| `region` - [`String`](#string) | | -| `region_id` - [`Int`](#int) | | -| `street` - [`String`](#string) | | - -#### Example - -```json -{ - "city": "abc123", - "contact_name": "abc123", - "country_id": "abc123", - "description": "xyz789", - "email": "abc123", - "fax": "abc123", - "latitude": 123.45, - "longitude": 987.65, - "name": "abc123", - "phone": "abc123", - "pickup_location_code": "xyz789", - "postcode": "xyz789", - "region": "xyz789", - "region_id": 123, - "street": "xyz789" -} -``` - - - -### PickupLocationFilterInput - -PickupLocationFilterInput defines the list of attributes and filters for the search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | +| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "city": FilterTypeInput, - "country_id": FilterTypeInput, - "name": FilterTypeInput, - "pickup_location_code": FilterTypeInput, - "postcode": FilterTypeInput, - "region": FilterTypeInput, - "region_id": FilterTypeInput, - "street": FilterTypeInput + "new_expiration": "xyz789", + "old_expiration": "abc123" } ``` -### PickupLocationSortInput +### NegotiableQuoteHistoryProductsRemovedChange -PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. +Contains lists of products that have been removed from the catalog and negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | -| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | +| Field Name | Description | +|------------|-------------| +| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | #### Example ```json { - "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" + "products_removed_from_catalog": ["4"], + "products_removed_from_quote": [ProductInterface] } ``` -### PickupLocations +### NegotiableQuoteHistoryStatusChange -Top level object returned in a pickup locations search. +Lists a new status change applied to a negotiable quote and the previous status. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](#int) | The number of products returned. | +| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | +| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json -{ - "items": [PickupLocation], - "page_info": SearchResultPageInfo, - "total_count": 987 -} +{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} ``` -### PlaceNegotiableQuoteOrderInput +### NegotiableQuoteHistoryStatusesChange -Specifies the negotiable quote to convert to an order. +Contains a list of status changes that occurred for the negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Field Name | Description | +|------------|-------------| +| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | #### Example ```json -{"quote_uid": 4} +{"changes": [NegotiableQuoteHistoryStatusChange]} ``` -### PlaceNegotiableQuoteOrderOutput +### NegotiableQuoteHistoryTotalChange -An output object that returns the generated order. +Contains a new price and the previous price. #### Fields | Field Name | Description | |------------|-------------| -| `order` - [`Order!`](#order) | Contains the generated order number. | +| `new_price` - [`Money`](#money) | The total price as a result of the change. | +| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | #### Example ```json -{"order": Order} +{ + "new_price": Money, + "old_price": Money +} ``` -### PlaceOrderError +### NegotiableQuoteInvalidStateError -An error encountered while placing an order. +An error indicating that an operation was attempted on a negotiable quote in an invalid state. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | +| `message` - [`String!`](#string) | The returned error message. | #### Example ```json -{ - "code": "CART_NOT_FOUND", - "message": "abc123" -} +{"message": "abc123"} ``` -### PlaceOrderErrorCodes +### NegotiableQuoteItemQuantityInput -#### Values +Specifies the updated quantity of an item. -| Enum Value | Description | -|------------|-------------| -| `CART_NOT_FOUND` | | -| `CART_NOT_ACTIVE` | | -| `GUEST_EMAIL_MISSING` | | -| `UNABLE_TO_PLACE_ORDER` | | -| `UNDEFINED` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -""CART_NOT_FOUND"" +{"quantity": 987.65, "quote_item_uid": "4"} ``` -### PlaceOrderForPurchaseOrderInput +### NegotiableQuotePaymentMethodInput -Specifies the purchase order to convert to an order. +Defines the payment method to be applied to the negotiable quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `code` - [`String!`](#string) | Payment method code | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json -{"purchase_order_uid": 4} +{ + "code": "xyz789", + "purchase_order_number": "abc123" +} ``` -### PlaceOrderForPurchaseOrderOutput - -Contains the results of the request to place an order. +### NegotiableQuoteShippingAddress #### Fields | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | #### Example ```json -{"order": CustomerOrder} +{ + "available_shipping_methods": [AvailableShippingMethod], + "city": "abc123", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "firstname": "abc123", + "lastname": "xyz789", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["xyz789"], + "telephone": "abc123" +} ``` -### PlaceOrderInput +### NegotiableQuoteShippingAddressInput -Specifies the quote to be converted to an order. +Defines shipping addresses for the negotiable quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json -{"cart_id": "abc123"} +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "customer_notes": "xyz789" +} ``` -### PlaceOrderOutput +### NegotiableQuoteSortInput -Contains the results of the request to place an order. +Defines the field to use to sort a list of negotiable quotes. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | -| `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | -| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example ```json -{ - "errors": [PlaceOrderError], - "order": Order, - "orderV2": CustomerOrder -} +{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} ``` -### PlacePurchaseOrderInput - -Specifies the quote to be converted to a purchase order. +### NegotiableQuoteSortableField -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| Enum Value | Description | +|------------|-------------| +| `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 ```json -{"cart_id": "xyz789"} +""QUOTE_NAME"" ``` -### PlacePurchaseOrderOutput - -Contains the results of the request to place a purchase order. +### NegotiableQuoteStatus -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | +| `SUBMITTED` | | +| `PENDING` | | +| `UPDATED` | | +| `OPEN` | | +| `ORDERED` | | +| `CLOSED` | | +| `DECLINED` | | +| `EXPIRED` | | +| `DRAFT` | | #### Example ```json -{"purchase_order": PurchaseOrder} +""SUBMITTED"" ``` -### Price +### NegotiableQuoteTemplate -Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. +Contains details about a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | -| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | #### Example ```json { - "adjustments": [PriceAdjustment], - "amount": Money + "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, + "shipping_addresses": [NegotiableQuoteShippingAddress], + "status": "abc123", + "template_id": 4, + "total_quantity": 123.45 } ``` -### PriceAdjustment +### NegotiableQuoteTemplateFilterInput -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. +Defines a filter to limit the negotiable quotes to return. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | -| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | -| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | +| Input Field | Description | +|-------------|-------------| +| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example ```json { - "amount": Money, - "code": "TAX", - "description": "INCLUDED" + "state": FilterEqualTypeInput, + "status": FilterEqualTypeInput } ``` -### PriceAdjustmentCodesEnum +### NegotiableQuoteTemplateGridItem -`PriceAdjustment.code` is deprecated. +Contains data for a negotiable quote template in a grid. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | -| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | -| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | +| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `state` - [`String!`](#string) | State of the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -""TAX"" +{ + "activated_at": "xyz789", + "company_name": "abc123", + "expiration_date": "abc123", + "is_min_max_qty_used": false, + "last_shared_at": "xyz789", + "max_order_commitment": 123, + "min_negotiated_grand_total": 123.45, + "min_order_commitment": 987, + "name": "abc123", + "orders_placed": 123, + "sales_rep_name": "xyz789", + "state": "abc123", + "status": "abc123", + "submitted_by": "abc123", + "template_id": 4 +} ``` -### PriceAdjustmentDescriptionEnum +### NegotiableQuoteTemplateItemQuantityInput -`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. +Specifies the updated quantity of an item. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `INCLUDED` | | -| `EXCLUDED` | | +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | #### Example ```json -""INCLUDED"" +{ + "item_id": "4", + "max_qty": 987.65, + "min_qty": 987.65, + "quantity": 987.65 +} ``` -### PriceDetails +### NegotiableQuoteTemplateShippingAddressInput -Can be used to retrieve the main price details in case of bundle product +Defines shipping addresses for the negotiable quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](#float) | The regular price of the main product | +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json { - "discount_percentage": 123.45, - "main_final_price": 123.45, - "main_price": 987.65 + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "customer_notes": "abc123" } ``` -### PriceRange +### NegotiableQuoteTemplateSortInput -Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same. +Defines the field to use to sort a list of negotiable quotes. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | -| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example ```json -{ - "maximum_price": ProductPrice, - "minimum_price": ProductPrice -} +{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} ``` -### PriceTypeEnum - -Defines the price type. +### NegotiableQuoteTemplateSortableField #### Values | Enum Value | Description | |------------|-------------| -| `FIXED` | | -| `PERCENT` | | -| `DYNAMIC` | | +| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | +| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | #### Example ```json -""FIXED"" +""TEMPLATE_ID"" ``` -### PriceViewEnum +### NegotiableQuoteTemplatesOutput -Defines whether a bundle product's price is displayed as the lowest possible value or as a range. +Contains a list of negotiable templates that match the specified filter. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `PRICE_RANGE` | | -| `AS_LOW_AS` | | +| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | #### Example ```json -""PRICE_RANGE"" +{ + "items": [NegotiableQuoteTemplateGridItem], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 987 +} ``` -### ProductAttribute - -Contains a product attribute code and value. +### NegotiableQuoteUidNonFatalResultInterface #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Possible Types + +| NegotiableQuoteUidNonFatalResultInterface Types | +|----------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | #### Example ```json -{ - "code": "abc123", - "value": "xyz789" -} +{"quote_uid": "4"} ``` -### ProductAttributeFilterInput +### NegotiableQuoteUidOperationSuccess -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. +Contains details about a successful operation on a negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `category_url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by category URL path. | -| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | -| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | -| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | -| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | +| Field Name | Description | +|------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "category_id": FilterEqualTypeInput, - "category_uid": FilterEqualTypeInput, - "category_url_path": FilterEqualTypeInput, - "description": FilterMatchTypeInput, - "name": FilterMatchTypeInput, - "price": FilterRangeTypeInput, - "short_description": FilterMatchTypeInput, - "sku": FilterEqualTypeInput, - "url_key": FilterEqualTypeInput -} +{"quote_uid": 4} ``` -### ProductAttributeSortInput +### NegotiableQuoteUser -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 +A limited view of a Buyer or Seller in the negotiable quote process. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | +| Field Name | Description | +|------------|-------------| +| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | #### Example ```json -{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} +{ + "firstname": "xyz789", + "lastname": "xyz789" +} ``` -### ProductCustomAttributes +### NegotiableQuotesOutput -Product custom attributes +Contains a list of negotiable that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | +| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [AttributeValueInterface] + "items": [NegotiableQuote], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 987 } ``` -### ProductDiscount +### NoSuchEntityUidError -Contains the discount applied to a product price. +Contains an error message when an invalid UID was specified. #### Fields | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `message` - [`String!`](#string) | The returned error message. | +| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | #### Example ```json -{"amount_off": 123.45, "percent_off": 987.65} +{"message": "abc123", "uid": 4} ``` -### ProductFilterInput +### OpenNegotiableQuoteTemplateInput -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. +Specifies the quote template id to open quote template. #### Input Fields | Input Field | Description | |-------------|-------------| -| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | -| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | -| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{ - "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 -} +{"template_id": 4} ``` -### ProductImage +### Order -Contains product image information, including the image URL and label. +Contains the order ID. #### Fields | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | +| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | #### Example ```json { - "disabled": true, - "label": "xyz789", - "position": 123, - "url": "xyz789" + "order_id": "xyz789", + "order_number": "abc123" } ``` -### ProductInfoInput +### OrderAddress -Product Information used for Pickup Locations search. +Contains detailed information about an order's billing and shipping addresses. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `fax` - [`String`](#string) | The fax number. | +| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | The state or province name. | +| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json -{"sku": "abc123"} +{ + "city": "xyz789", + "company": "xyz789", + "country_code": "AF", + "fax": "abc123", + "firstname": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "xyz789", + "region": "xyz789", + "region_id": "4", + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "abc123" +} ``` -### ProductInterface +### OrderInformationInput -Contains fields that are common to all types of products. +Input to retrieve an order based on details. -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Possible Types - -| ProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | - -#### Example - -```json -{ - "attribute_set_id": 123, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": "abc123", - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options_container": "xyz789", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 987.65, - "related_products": [ProductInterface], - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": false, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "tier_price": 123.45, - "tier_prices": [ProductTierPrices], - "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] -} -``` - - - -### ProductLinks - -An implementation of `ProductLinksInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Example - -```json -{ - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 123, - "sku": "xyz789" -} -``` - - - -### ProductLinksInterface - -Contains information about linked products, including the link type and product type of each item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Possible Types - -| ProductLinksInterface Types | -|----------------| -| [`ProductLinks`](#productlinks) | - -#### Example - -```json -{ - "link_type": "abc123", - "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 987, - "sku": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesContent - -Contains an image in base64 format and basic information about the image. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | -| `name` - [`String`](#string) | The file name of the image. | -| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | - -#### Example - -```json -{ - "base64_encoded_data": "xyz789", - "name": "abc123", - "type": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesVideoContent - -Contains a link to a video file and basic information about the video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `media_type` - [`String`](#string) | Must be external-video. | -| `video_description` - [`String`](#string) | A description of the video. | -| `video_metadata` - [`String`](#string) | Optional data about the video. | -| `video_provider` - [`String`](#string) | Describes the video source. | -| `video_title` - [`String`](#string) | The title of the video. | -| `video_url` - [`String`](#string) | The URL to the video. | - -#### Example - -```json -{ - "media_type": "xyz789", - "video_description": "abc123", - "video_metadata": "xyz789", - "video_provider": "abc123", - "video_title": "xyz789", - "video_url": "abc123" -} -``` - - - -### ProductPrice - -Represents a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | -| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | -| `regular_price` - [`Money!`](#money) | The regular price of the product. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "fixed_product_taxes": [FixedProductTax], - "regular_price": Money -} -``` - - - -### ProductPrices - -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 Name | Description | -|------------|-------------| -| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | -| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | -| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | - -#### Example - -```json -{ - "maximalPrice": Price, - "minimalPrice": Price, - "regularPrice": Price -} -``` - - - -### ProductReview - -Contains details of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](#string) | The date the review was created. | -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | -| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | - -#### Example - -```json -{ - "average_rating": 123.45, - "created_at": "xyz789", - "nickname": "abc123", - "product": ProductInterface, - "ratings_breakdown": [ProductReviewRating], - "summary": "xyz789", - "text": "abc123" -} -``` - - - -### ProductReviewRating - -Contains data about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | - -#### Example - -```json -{ - "name": "abc123", - "value": "xyz789" -} -``` - - - -### ProductReviewRatingInput - -Contains the reviewer's rating for a single aspect of a review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "id": "xyz789", - "value_id": "abc123" -} -``` - - - -### ProductReviewRatingMetadata - -Contains details about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | - -#### Example - -```json -{ - "id": "xyz789", - "name": "xyz789", - "values": [ProductReviewRatingValueMetadata] -} -``` - - - -### ProductReviewRatingValueMetadata - -Contains details about a single value in a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "value": "abc123", - "value_id": "xyz789" -} -``` - - - -### ProductReviewRatingsMetadata - -Contains an array of metadata about each aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | - -#### Example - -```json -{"items": [ProductReviewRatingMetadata]} -``` - - - -### ProductReviews - -Contains an array of product reviews. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | - -#### Example - -```json -{ - "items": [ProductReview], - "page_info": SearchResultPageInfo -} -``` - - - -### ProductStockStatus - -This enumeration states whether a product stock status is in stock or out of stock - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `IN_STOCK` | | -| `OUT_OF_STOCK` | | - -#### Example - -```json -""IN_STOCK"" -``` - - - -### ProductTierPrices - -Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | - -#### Example - -```json -{ - "customer_group_id": "xyz789", - "percentage_value": 123.45, - "qty": 987.65, - "value": 987.65, - "website_id": 987.65 -} -``` - - - -### ProductVideo - -Contains information about a product video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | - -#### Example - -```json -{ - "disabled": true, - "label": "xyz789", - "position": 987, - "url": "abc123", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### Products - -Contains the results of a `products` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | -| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](#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 - -```json -{ - "aggregations": [Aggregation], - "filters": [LayerFilter], - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "suggestions": [SearchSuggestion], - "total_count": 987 -} -``` - - - -### PurchaseOrder - -Contains details about a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | -| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | -| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | -| `created_at` - [`String!`](#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | -| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | -| `number` - [`String!`](#string) | The purchase order number. | -| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | -| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | - -#### Example - -```json -{ - "approval_flow": [PurchaseOrderRuleApprovalFlow], - "available_actions": ["REJECT"], - "comments": [PurchaseOrderComment], - "created_at": "abc123", - "created_by": Customer, - "history_log": [PurchaseOrderHistoryItem], - "number": "abc123", - "order": CustomerOrder, - "quote": Cart, - "status": "PENDING", - "uid": "4", - "updated_at": "abc123" -} -``` - - - -### PurchaseOrderAction - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REJECT` | | -| `CANCEL` | | -| `VALIDATE` | | -| `APPROVE` | | -| `PLACE_ORDER` | | - -#### Example - -```json -""REJECT"" -``` - - - -### PurchaseOrderActionError - -Contains details about a failed action. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | - -#### Example - -```json -{"message": "xyz789", "type": "NOT_FOUND"} -``` - - - -### PurchaseOrderApprovalFlowEvent - -Contains details about a single event in the approval flow of the purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | -| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](#string) | The date and time the event was updated. | - -#### Example - -```json -{ - "message": "abc123", - "name": "abc123", - "role": "xyz789", - "status": "PENDING", - "updated_at": "abc123" -} -``` - - - -### PurchaseOrderApprovalFlowItemStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVED` | | -| `REJECTED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrderApprovalRule - -Contains details about a purchase order approval rule. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | -| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | -| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](#string) | The name of the purchase order approval rule. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | - -#### Example - -```json -{ - "applies_to_roles": [CompanyRole], - "approver_roles": [CompanyRole], - "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "xyz789", - "description": "xyz789", - "name": "xyz789", - "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" -} -``` - - - -### PurchaseOrderApprovalRuleConditionAmount - -Contains approval rule condition details, including the amount to be evaluated. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Example - -```json -{ - "amount": Money, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN" -} -``` - - - -### PurchaseOrderApprovalRuleConditionInterface - -Purchase order rule condition details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Possible Types - -| PurchaseOrderApprovalRuleConditionInterface Types | -|----------------| -| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | -| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} -``` - - - -### PurchaseOrderApprovalRuleConditionOperator - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `MORE_THAN` | | -| `LESS_THAN` | | -| `MORE_THAN_OR_EQUAL_TO` | | -| `LESS_THAN_OR_EQUAL_TO` | | - -#### Example - -```json -""MORE_THAN"" -``` - - - -### PurchaseOrderApprovalRuleConditionQuantity - -Contains approval rule condition details, including the quantity to be evaluated. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | -| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} -``` - - - -### PurchaseOrderApprovalRuleInput - -Defines a new purchase order approval rule. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](#string) | The purchase order approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | - -#### Example - -```json -{ - "applies_to": [4], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "abc123", - "status": "ENABLED" -} -``` - - - -### PurchaseOrderApprovalRuleMetadata - -Contains metadata that can be used to render rule edit forms. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | - -#### Example - -```json -{ - "available_applies_to": [CompanyRole], - "available_condition_currencies": [AvailableCurrency], - "available_requires_approval_from": [CompanyRole] -} -``` - - - -### PurchaseOrderApprovalRuleStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ENABLED` | | -| `DISABLED` | | - -#### Example - -```json -""ENABLED"" -``` - - - -### PurchaseOrderApprovalRuleType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `GRAND_TOTAL` | | -| `SHIPPING_INCL_TAX` | | -| `NUMBER_OF_SKUS` | | - -#### Example - -```json -""GRAND_TOTAL"" -``` - - - -### PurchaseOrderApprovalRules - -Contains the approval rules that the customer can see. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | - -#### Example - -```json -{ - "items": [PurchaseOrderApprovalRule], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### PurchaseOrderComment - -Contains details about a comment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`Customer`](#customer) | The user who left the comment. | -| `created_at` - [`String!`](#string) | The date and time when the comment was created. | -| `text` - [`String!`](#string) | The text of the comment. | -| `uid` - [`ID!`](#id) | A unique identifier of the comment. | - -#### Example - -```json -{ - "author": Customer, - "created_at": "xyz789", - "text": "abc123", - "uid": 4 -} -``` - - - -### PurchaseOrderErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | - -#### Example - -```json -""NOT_FOUND"" -``` - - - -### PurchaseOrderHistoryItem - -Contains details about a status change. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String!`](#string) | The activity type of the event. | -| `created_at` - [`String!`](#string) | The date and time when the event happened. | -| `message` - [`String!`](#string) | The message representation of the event. | -| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | - -#### Example - -```json -{ - "activity": "abc123", - "created_at": "xyz789", - "message": "xyz789", - "uid": "4" -} -``` - - - -### PurchaseOrderRuleApprovalFlow - -Contains details about approval roles applied to the purchase order and status changes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | - -#### Example - -```json -{ - "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "abc123" -} -``` - - - -### PurchaseOrderStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVAL_REQUIRED` | | -| `APPROVED` | | -| `ORDER_IN_PROGRESS` | | -| `ORDER_PLACED` | | -| `ORDER_FAILED` | | -| `REJECTED` | | -| `CANCELED` | | -| `APPROVED_PENDING_PAYMENT` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrders - -Contains a list of purchase orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | - -#### Example - -```json -{ - "items": [PurchaseOrder], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### PurchaseOrdersActionInput - -Defines which purchase orders to act on. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | - -#### Example - -```json -{"purchase_order_uids": ["4"]} -``` - - - -### PurchaseOrdersActionOutput - -Returns a list of updated purchase orders and any error messages. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | - -#### Example - -```json -{ - "errors": [PurchaseOrderActionError], - "purchase_orders": [PurchaseOrder] -} -``` - - - -### PurchaseOrdersFilterInput - -Defines the criteria to use to filter the list of purchase orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | -| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | - -#### Example - -```json -{ - "company_purchase_orders": true, - "created_date": FilterRangeTypeInput, - "require_my_approval": false, - "status": "PENDING" -} -``` - - - -### QuoteItemsSortInput - -Specifies the field to use for sorting quote items - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | -| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | - -#### Example - -```json -{"field": "ITEM_ID", "order": "ASC"} -``` - - - -### QuoteTemplateLineItemNoteInput - -Sets quote item note. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "item_id": "4", - "note": "xyz789", - "templateId": "4" -} -``` - - - -### QuoteTemplateNotificationMessage - -Contains a notification message for a negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The notification message. | -| `type` - [`String!`](#string) | The type of notification message. | - -#### Example - -```json -{ - "message": "xyz789", - "type": "abc123" -} -``` - - - -### ReCaptchaConfigurationV3 - -Contains reCAPTCHA V3-Invisible configuration details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | -| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | - -#### Example - -```json -{ - "badge_position": "xyz789", - "failure_message": "abc123", - "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 987.65, - "website_key": "xyz789" -} -``` - - - -### ReCaptchaFormEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PLACE_ORDER` | | -| `CONTACT` | | -| `CUSTOMER_LOGIN` | | -| `CUSTOMER_FORGOT_PASSWORD` | | -| `CUSTOMER_CREATE` | | -| `CUSTOMER_EDIT` | | -| `NEWSLETTER` | | -| `PRODUCT_REVIEW` | | -| `SENDFRIEND` | | -| `BRAINTREE` | | - -#### Example - -```json -""PLACE_ORDER"" -``` - - - -### Region - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](#int) | The unique ID for a `Region` object. | -| `name` - [`String`](#string) | The name of the region, such as Texas. | - -#### Example - -```json -{ - "code": "xyz789", - "id": 987, - "name": "abc123" -} -``` - - - -### RemoveCouponFromCartInput - -Specifies the cart from which to remove a coupon. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### RemoveCouponFromCartOutput - -Contains details about the cart after removing a coupon. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveCouponsFromCartInput - -Remove coupons from the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#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 - -```json -{ - "cart_id": "xyz789", - "coupon_codes": ["xyz789"] -} -``` - - - -### RemoveGiftCardFromCartInput - -Defines the input required to run the `removeGiftCardFromCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "gift_card_code": "xyz789" -} -``` - - - -### RemoveGiftCardFromCartOutput - -Defines the possible output for the `removeGiftCardFromCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveGiftRegistryItemsOutput - -Contains the results of a request to remove an item from a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### RemoveGiftRegistryOutput - -Contains the results of a request to delete a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | - -#### Example - -```json -{"success": true} -``` - - - -### RemoveGiftRegistryRegistrantsOutput - -Contains the results of a request to delete a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### RemoveItemFromCartInput - -Specifies which items to remove from the cart. - -#### Input Fields +#### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `email` - [`String!`](#string) | Order billing address email. | +| `number` - [`String!`](#string) | Order number. | +| `postcode` - [`String!`](#string) | Order billing address postcode. | #### Example ```json { - "cart_id": "abc123", - "cart_item_id": 123, - "cart_item_uid": 4 + "email": "abc123", + "number": "abc123", + "postcode": "abc123" } ``` -### RemoveItemFromCartOutput - -Contains details about the cart after removing an item. +### OrderItem #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveNegotiableQuoteItemsInput - -Defines the items to remove from the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "quote_item_uids": ["4"], - "quote_uid": "4" + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "product": ProductInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "xyz789", + "product_url_key": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "abc123" } ``` -### RemoveNegotiableQuoteItemsOutput +### OrderItemInterface -Contains the negotiable quote. +Order item details. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### RemoveNegotiableQuoteTemplateItemsInput - -Defines the items to remove from the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "item_uids": ["4"], - "template_id": "4" -} -``` - - - -### RemoveProductsFromCompareListInput - -Defines which products to remove from a compare list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | - -#### Example - -```json -{"products": [4], "uid": "4"} -``` - - - -### RemoveProductsFromWishlistOutput - -Contains the customer's wish list and any errors encountered. - -#### Fields +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | +#### Possible Types + +| OrderItemInterface Types | +|----------------| +| [`DownloadableOrderItem`](#downloadableorderitem) | +| [`BundleOrderItem`](#bundleorderitem) | +| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`OrderItem`](#orderitem) | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "product": ProductInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "product_type": "abc123", + "product_url_key": "xyz789", + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" } ``` -### RemoveReturnTrackingInput +### OrderItemOption -Defines the tracking information to delete. +Represents order item options like selected or entered. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The name of the option. | +| `value` - [`String!`](#string) | The value of the option. | #### Example ```json -{"return_shipping_tracking_uid": 4} +{ + "label": "abc123", + "value": "xyz789" +} ``` -### RemoveReturnTrackingOutput +### OrderPaymentMethod -Contains the response after deleting tracking information. +Contains details about the payment method used to pay for the order. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Contains details about the modified return. | +| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | +| `name` - [`String!`](#string) | The label that describes the payment method. | +| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | #### Example ```json -{"return": Return} +{ + "additional_data": [KeyValue], + "name": "abc123", + "type": "xyz789" +} ``` -### RemoveRewardPointsFromCartOutput +### OrderShipment -Contains the customer cart. +Contains order shipment details. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | #### Example ```json -{"cart": Cart} +{ + "comments": [SalesCommentItem], + "id": 4, + "items": [ShipmentItemInterface], + "number": "abc123", + "tracking": [ShipmentTracking] +} ``` -### RemoveStoreCreditFromCartInput +### OrderTokenInput -Defines the input required to run the `removeStoreCreditFromCart` mutation. +Input to retrieve an order based on token. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `token` - [`String!`](#string) | Order token. | #### Example ```json -{"cart_id": "xyz789"} +{"token": "abc123"} ``` -### RemoveStoreCreditFromCartOutput +### OrderTotal -Defines the possible output for the `removeStoreCreditFromCart` mutation. +Contains details about the sales total amounts used to calculate the final price. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | +| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | +| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | #### Example ```json -{"cart": Cart} +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_giftcard": Money, + "total_shipping": Money, + "total_tax": Money +} ``` -### RenameNegotiableQuoteInput +### PayflowExpressInput -Sets new name for a negotiable quote. +Contains required input for Payflow Express Checkout payments. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | -| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | -| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { - "quote_comment": "xyz789", - "quote_name": "xyz789", - "quote_uid": 4 + "payer_id": "abc123", + "token": "xyz789" } ``` -### RenameNegotiableQuoteOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### ReorderItemsOutput +### PayflowLinkInput -Contains the cart and any errors after adding products. +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 Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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!`](#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 ```json { - "cart": Cart, - "userInputErrors": [CheckoutUserInputError] + "cancel_url": "xyz789", + "error_url": "xyz789", + "return_url": "abc123" } ``` -### RequestNegotiableQuoteInput +### PayflowLinkMode -Defines properties of a negotiable quote request. +Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | -| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | +| Enum Value | Description | +|------------|-------------| +| `TEST` | | +| `LIVE` | | #### Example ```json -{ - "cart_id": 4, - "comment": NegotiableQuoteCommentInput, - "is_draft": false, - "quote_name": "xyz789" -} +""TEST"" ``` -### RequestNegotiableQuoteOutput +### PayflowLinkToken -Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. +Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | +| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | #### Example ```json -{"quote": NegotiableQuote} +{ + "mode": "TEST", + "paypal_url": "abc123", + "secure_token": "abc123", + "secure_token_id": "xyz789" +} ``` -### RequestNegotiableQuoteTemplateInput +### PayflowLinkTokenInput -Defines properties of a negotiable quote template request. +Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": 4} +{"cart_id": "xyz789"} ``` -### RequestReturnInput +### PayflowProInput -Contains information needed to start a return request. +Contains input for the Payflow Pro and Payments Pro payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | +| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](#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 ```json { - "comment_text": "abc123", - "contact_email": "xyz789", - "items": [RequestReturnItemInput], - "order_uid": 4 + "cc_details": CreditCardDetailsInput, + "is_active_payment_token_enabler": true } ``` -### RequestReturnItemInput +### PayflowProResponseInput -Contains details about an item to be returned. +Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | -| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | #### Example ```json { - "entered_custom_attributes": [ - EnteredCustomAttributeInput - ], - "order_item_uid": "4", - "quantity_to_return": 123.45, - "selected_custom_attributes": [ - SelectedCustomAttributeInput - ] + "cart_id": "abc123", + "paypal_payload": "abc123" } ``` -### RequestReturnOutput - -Contains the response to a return request. +### PayflowProResponseOutput #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about a single return request. | -| `returns` - [`Returns`](#returns) | An array of return requests. | +| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | #### Example ```json -{ - "return": Return, - "returns": Returns -} +{"cart": Cart} ``` -### RequisitionList +### PayflowProTokenInput -Defines the contents of a requisition list. +Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `description` - [`String`](#string) | Optional text that describes the requisition list. | -| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | -| `items_count` - [`Int!`](#int) | The number of items in the list. | -| `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | -| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example ```json { - "description": "abc123", - "items": RequistionListItems, - "items_count": 123, - "name": "xyz789", - "uid": 4, - "updated_at": "abc123" + "cart_id": "abc123", + "urls": PayflowProUrlInput } ``` -### RequisitionListFilterInput +### PayflowProUrlInput -Defines requisition list filters. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `cancel_url` - [`String!`](#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!`](#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!`](#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 ```json { - "name": FilterMatchTypeInput, - "uids": FilterEqualTypeInput + "cancel_url": "abc123", + "error_url": "abc123", + "return_url": "xyz789" } ``` -### RequisitionListItemInterface +### PaymentConfigItem -The interface for requisition list items. +Contains payment fields that are common to all types of payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | #### Possible Types -| RequisitionListItemInterface Types | +| PaymentConfigItem Types | |----------------| -| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 -} -``` - - - -### RequisitionListItemsInput - -Defines the items to add. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | -| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](#float) | The quantity of the product to add. | -| `selected_options` - [`[String]`](#string) | Selected option IDs. | -| `sku` - [`String!`](#string) | The product SKU. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["xyz789"], - "sku": "xyz789" -} -``` - - - -### RequisitionLists - -Defines customer requisition lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| [`HostedFieldsConfig`](#hostedfieldsconfig) | +| [`SmartButtonsConfig`](#smartbuttonsconfig) | +| [`ApplePayConfig`](#applepayconfig) | +| [`GooglePayConfig`](#googlepayconfig) | #### Example ```json { - "items": [RequisitionList], - "page_info": SearchResultPageInfo, - "total_count": 123 + "code": "xyz789", + "is_visible": true, + "payment_intent": "abc123", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "title": "abc123" } ``` -### RequistionListItems +### PaymentConfigOutput -Contains an array of items added to a requisition list. +Retrieves the payment configuration for a given location #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](#int) | The number of pages returned. | +| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | +| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example ```json { - "items": [RequisitionListItemInterface], - "page_info": SearchResultPageInfo, - "total_pages": 123 + "apple_pay": ApplePayConfig, + "google_pay": GooglePayConfig, + "hosted_fields": HostedFieldsConfig, + "smart_buttons": SmartButtonsConfig } ``` -### Return +### PaymentLocation -Contains details about a return. +Defines the origin location for that payment request -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | -| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | -| `created_at` - [`String!`](#string) | The date the return was requested. | -| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | -| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | -| `number` - [`String!`](#string) | A human-readable return number. | -| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | -| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | -| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | -| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| `PRODUCT_DETAIL` | | +| `MINICART` | | +| `CART` | | +| `CHECKOUT` | | +| `ADMIN` | | #### Example ```json -{ - "available_shipping_carriers": [ReturnShippingCarrier], - "comments": [ReturnComment], - "created_at": "abc123", - "customer": ReturnCustomer, - "items": [ReturnItem], - "number": "abc123", - "order": CustomerOrder, - "shipping": ReturnShipping, - "status": "PENDING", - "uid": "4" -} +""PRODUCT_DETAIL"" ``` -### ReturnComment +### PaymentMethodInput -Contains details about a return comment. +Defines the payment method. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `author_name` - [`String!`](#string) | The name or author who posted the comment. | -| `created_at` - [`String!`](#string) | The date and time the comment was posted. | -| `text` - [`String!`](#string) | The contents of the comment. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | +| Input Field | Description | +|-------------|-------------| +| `braintree` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `code` - [`String!`](#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | +| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | +| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | +| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | +| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "author_name": "abc123", - "created_at": "xyz789", - "text": "abc123", - "uid": 4 + "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_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" } ``` -### ReturnCustomAttribute +### PaymentOrderOutput -Contains details about a `ReturnCustomerAttribute` object. +Contains the payment order details #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | -| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json { - "label": "abc123", - "uid": "4", - "value": "xyz789" + "id": "abc123", + "mp_order_id": "xyz789", + "payment_source_details": PaymentSourceDetails, + "status": "abc123" } ``` -### ReturnCustomer - -The customer information for the return. +### PaymentSDKParamsItem #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the customer. | -| `firstname` - [`String`](#string) | The first name of the customer. | -| `lastname` - [`String`](#string) | The last name of the customer. | +| `code` - [`String`](#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | #### Example ```json { - "email": "abc123", - "firstname": "abc123", - "lastname": "abc123" + "code": "xyz789", + "params": [SDKParams] } ``` -### ReturnItem - -Contains details about a product being returned. +### PaymentSourceDetails #### Fields | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | -| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | +| `card` - [`Card`](#card) | Details about the card used on the order | #### Example ```json -{ - "custom_attributes": [ReturnCustomAttribute], - "custom_attributesV2": [AttributeValueInterface], - "order_item": OrderItemInterface, - "quantity": 987.65, - "request_quantity": 987.65, - "status": "PENDING", - "uid": 4 -} +{"card": Card} ``` -### ReturnItemAttributeMetadata +### PaymentToken -Return Item attribute metadata. +The stored payment method available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | +| `details` - [`String`](#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](#string) | The public hash of the token. | +| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "code": 4, - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": false, - "is_unique": true, - "label": "abc123", - "multiline_count": 123, - "options": [CustomAttributeOptionInterface], - "sort_order": 123, - "validate_rules": [ValidationRule] + "details": "xyz789", + "payment_method_code": "abc123", + "public_hash": "xyz789", + "type": "card" } ``` -### ReturnItemStatus +### PaymentTokenTypeEnum + +The list of available payment token types. #### Values | Enum Value | Description | |------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `RECEIVED` | | -| `APPROVED` | | -| `REJECTED` | | -| `DENIED` | | +| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | #### Example ```json -""PENDING"" +""card"" ``` -### ReturnShipping +### PaypalExpressInput -Contains details about the return shipping address. +Contains required input for Express Checkout and Payments Standard payments. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | -| `tracking` - [`[ReturnShippingTracking]`](#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. | +| Input Field | Description | +|-------------|-------------| +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "address": ReturnShippingAddress, - "tracking": [ReturnShippingTracking] + "payer_id": "abc123", + "token": "abc123" } ``` -### ReturnShippingAddress +### PaypalExpressTokenInput -Contains details about the shipping address used for receiving returned items. +Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city for product returns. | -| `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](#country) | An object that defines the country for product returns. | -| `postcode` - [`String!`](#string) | The postal code for product returns. | -| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | -| `street` - [`[String]!`](#string) | The street address for product returns. | -| `telephone` - [`String`](#string) | The telephone number for product returns. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](#string) | The payment method code. | +| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | +| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "city": "xyz789", - "contact_name": "xyz789", - "country": Country, - "postcode": "xyz789", - "region": Region, - "street": ["abc123"], - "telephone": "xyz789" + "cart_id": "xyz789", + "code": "xyz789", + "express_button": false, + "urls": PaypalExpressUrlsInput, + "use_paypal_credit": false } ``` -### ReturnShippingCarrier +### PaypalExpressTokenOutput -Contains details about the carrier on a return. +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 Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | +| `token` - [`String`](#string) | The token returned by PayPal. | #### Example ```json -{"label": "xyz789", "uid": 4} +{ + "paypal_urls": PaypalExpressUrlList, + "token": "xyz789" +} ``` -### ReturnShippingTracking +### PaypalExpressUrlList -Contains shipping and tracking details. +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 Name | Description | |------------|-------------| -| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | -| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | -| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](#string) | The URL to the PayPal login page. | #### Example ```json { - "carrier": ReturnShippingCarrier, - "status": ReturnShippingTrackingStatus, - "tracking_number": "xyz789", - "uid": 4 + "edit": "abc123", + "start": "abc123" } ``` -### ReturnShippingTrackingStatus +### PaypalExpressUrlsInput -Contains the status of a shipment. +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 Fields -| Field Name | Description | -|------------|-------------| -| `text` - [`String!`](#string) | Text that describes the status. | -| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 ```json -{"text": "abc123", "type": "INFORMATION"} +{ + "cancel_url": "abc123", + "pending_url": "xyz789", + "return_url": "xyz789", + "success_url": "xyz789" +} ``` -### ReturnShippingTrackingStatusType +### PhysicalProductInterface -#### Values +Contains attributes specific to tangible products. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `INFORMATION` | | -| `ERROR` | | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Possible Types + +| PhysicalProductInterface Types | +|----------------| +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | #### Example ```json -""INFORMATION"" +{"weight": 987.65} ``` -### ReturnStatus +### PickupLocation -#### Values +Defines Pickup Location information. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `PARTIALLY_AUTHORIZED` | | -| `RECEIVED` | | -| `PARTIALLY_RECEIVED` | | -| `APPROVED` | | -| `PARTIALLY_APPROVED` | | -| `REJECTED` | | -| `PARTIALLY_REJECTED` | | -| `DENIED` | | -| `PROCESSED_AND_CLOSED` | | -| `CLOSED` | | +| `city` - [`String`](#string) | | +| `contact_name` - [`String`](#string) | | +| `country_id` - [`String`](#string) | | +| `description` - [`String`](#string) | | +| `email` - [`String`](#string) | | +| `fax` - [`String`](#string) | | +| `latitude` - [`Float`](#float) | | +| `longitude` - [`Float`](#float) | | +| `name` - [`String`](#string) | | +| `phone` - [`String`](#string) | | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | | +| `region` - [`String`](#string) | | +| `region_id` - [`Int`](#int) | | +| `street` - [`String`](#string) | | #### Example ```json -""PENDING"" +{ + "city": "xyz789", + "contact_name": "xyz789", + "country_id": "abc123", + "description": "abc123", + "email": "abc123", + "fax": "xyz789", + "latitude": 123.45, + "longitude": 987.65, + "name": "abc123", + "phone": "abc123", + "pickup_location_code": "xyz789", + "postcode": "xyz789", + "region": "xyz789", + "region_id": 123, + "street": "xyz789" +} ``` -### Returns +### PickupLocationFilterInput -Contains a list of customer return requests. +PickupLocationFilterInput defines the list of attributes and filters for the search. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[Return]`](#return) | A list of return requests. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | #### Example ```json { - "items": [Return], - "page_info": SearchResultPageInfo, - "total_count": 987 + "city": FilterTypeInput, + "country_id": FilterTypeInput, + "name": FilterTypeInput, + "pickup_location_code": FilterTypeInput, + "postcode": FilterTypeInput, + "region": FilterTypeInput, + "region_id": FilterTypeInput, + "street": FilterTypeInput } ``` -### RevokeCustomerTokenOutput +### PickupLocationSortInput -Contains the result of a request to revoke a customer token. +PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | +| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | #### Example ```json -{"result": true} +{ + "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" +} ``` -### RewardPoints +### PickupLocations -Contains details about a customer's reward points. +Top level object returned in a pickup locations search. #### Fields | Field Name | Description | |------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | -| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | -| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | +| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](#int) | The number of products returned. | #### Example ```json { - "balance": RewardPointsAmount, - "balance_history": [RewardPointsBalanceHistoryItem], - "exchange_rates": RewardPointsExchangeRates, - "subscription_status": RewardPointsSubscriptionStatus + "items": [PickupLocation], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### RewardPointsAmount +### PlaceNegotiableQuoteOrderInput -#### Fields +Specifies the negotiable quote to convert to an order. -| Field Name | Description | -|------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"money": Money, "points": 123.45} +{"quote_uid": "4"} ``` -### RewardPointsBalanceHistoryItem +### PlaceNegotiableQuoteOrderOutput -Contain details about the reward points transaction. +An output object that returns the generated order. #### Fields | Field Name | Description | |------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | -| `change_reason` - [`String!`](#string) | The reason the balance changed. | -| `date` - [`String!`](#string) | The date of the transaction. | -| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | +| `order` - [`Order!`](#order) | Contains the generated order number. | #### Example ```json -{ - "balance": RewardPointsAmount, - "change_reason": "abc123", - "date": "abc123", - "points_change": 987.65 -} +{"order": Order} ``` -### RewardPointsExchangeRates +### PlaceOrderError -Lists the reward points exchange rates. The values depend on the customer group. +An error encountered while placing an order. #### Fields | Field Name | Description | |------------|-------------| -| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | -| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | +| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "earning": RewardPointsRate, - "redemption": RewardPointsRate + "code": "CART_NOT_FOUND", + "message": "xyz789" } ``` -### RewardPointsRate - -Contains details about customer's reward points rate. +### PlaceOrderErrorCodes -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `currency_amount` - [`Float!`](#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!`](#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. | +| `CART_NOT_FOUND` | | +| `CART_NOT_ACTIVE` | | +| `GUEST_EMAIL_MISSING` | | +| `UNABLE_TO_PLACE_ORDER` | | +| `UNDEFINED` | | #### Example ```json -{"currency_amount": 123.45, "points": 987.65} +""CART_NOT_FOUND"" ``` -### RewardPointsSubscriptionStatus +### PlaceOrderForPurchaseOrderInput -Indicates whether the customer subscribes to reward points emails. +Specifies the purchase order to convert to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | -| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | #### Example ```json -{ - "balance_updates": "SUBSCRIBED", - "points_expiration_notifications": "SUBSCRIBED" -} +{"purchase_order_uid": "4"} ``` -### RewardPointsSubscriptionStatusesEnum +### PlaceOrderForPurchaseOrderOutput -#### Values +Contains the results of the request to place an order. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `SUBSCRIBED` | | -| `NOT_SUBSCRIBED` | | +| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | #### Example ```json -""SUBSCRIBED"" +{"order": CustomerOrder} ``` -### RoutableInterface - -Routable entities serve as the model for a rendered page. - -#### Fields +### PlaceOrderInput -| Field Name | Description | -|------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +Specifies the quote to be converted to an order. -#### Possible Types +#### Input Fields -| RoutableInterface Types | -|----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`RoutableUrl`](#routableurl) | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -{ - "redirect_code": 123, - "relative_url": "xyz789", - "type": "CMS_PAGE" -} +{"cart_id": "abc123"} ``` -### RoutableUrl +### PlaceOrderOutput -Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | +| `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | +| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | #### Example ```json { - "redirect_code": 987, - "relative_url": "abc123", - "type": "CMS_PAGE" + "errors": [PlaceOrderError], + "order": Order, + "orderV2": CustomerOrder } ``` -### SDKParams +### PlacePurchaseOrderInput -Defines the name and value of a SDK parameter +Specifies the quote to be converted to a purchase order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name of the SDK parameter | -| `value` - [`String`](#string) | The value of the SDK parameter | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -{ - "name": "abc123", - "value": "abc123" -} +{"cart_id": "abc123"} ``` -### SalesCommentItem +### PlacePurchaseOrderOutput -Contains details about a comment. +Contains the results of the request to place a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The text of the message. | -| `timestamp` - [`String!`](#string) | The timestamp of the comment. | +| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | #### Example ```json -{ - "message": "abc123", - "timestamp": "abc123" -} +{"purchase_order": PurchaseOrder} ``` -### ScopeTypeEnum +### Price -This enumeration defines the scope type for customer orders. +Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `GLOBAL` | | -| `WEBSITE` | | -| `STORE` | | +| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | +| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | #### Example ```json -""GLOBAL"" +{ + "adjustments": [PriceAdjustment], + "amount": Money +} ``` -### SearchResultPageInfo +### PriceAdjustment -Provides navigation for the query response. +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 Name | Description | |------------|-------------| -| `current_page` - [`Int`](#int) | The specific page to return. | -| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](#int) | The total number of pages in the response. | +| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | +| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | +| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | #### Example ```json -{"current_page": 987, "page_size": 987, "total_pages": 123} +{ + "amount": Money, + "code": "TAX", + "description": "INCLUDED" +} ``` -### SearchSuggestion +### PriceAdjustmentCodesEnum -A string that contains search suggestion +`PriceAdjustment.code` is deprecated. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `search` - [`String!`](#string) | The search suggestion of existing product. | +| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | +| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | +| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | #### Example ```json -{"search": "xyz789"} +""TAX"" ``` -### SelectedBundleOption +### PriceAdjustmentDescriptionEnum -Contains details about a selected bundle option. +`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | -| `label` - [`String!`](#string) | The display name of the selected bundle product option. | -| `type` - [`String!`](#string) | The type of selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | -| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | +| `INCLUDED` | | +| `EXCLUDED` | | #### Example ```json -{ - "id": 987, - "label": "abc123", - "type": "abc123", - "uid": "4", - "values": [SelectedBundleOptionValue] -} +""INCLUDED"" ``` -### SelectedBundleOptionValue +### PriceDetails -Contains details about a value for a selected bundle option. +Can be used to retrieve the main price details in case of bundle product #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | -| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](#float) | The regular price of the main product | #### Example ```json { - "id": 987, - "label": "xyz789", - "price": 123.45, - "quantity": 123.45, - "uid": 4 + "discount_percentage": 987.65, + "main_final_price": 987.65, + "main_price": 987.65 } ``` -### SelectedConfigurableOption +### PriceRange -Contains details about a selected configurable option. +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 Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | -| `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | -| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | +| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | +| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | #### Example ```json { - "configurable_product_option_uid": "4", - "configurable_product_option_value_uid": "4", - "id": 987, - "option_label": "abc123", - "value_id": 123, - "value_label": "abc123" + "maximum_price": ProductPrice, + "minimum_price": ProductPrice } ``` -### SelectedCustomAttributeInput - -Contains details about an attribute the buyer selected. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`ID!`](#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | - -#### Example - -```json -{"attribute_code": "abc123", "value": 4} -``` - - - -### SelectedCustomizableOption +### PriceTypeEnum -Identifies a customized product that has been placed in a cart. +Defines the price type. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | -| `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | -| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | -| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | +| `FIXED` | | +| `PERCENT` | | +| `DYNAMIC` | | #### Example ```json -{ - "customizable_option_uid": 4, - "id": 123, - "is_required": true, - "label": "abc123", - "sort_order": 123, - "type": "xyz789", - "values": [SelectedCustomizableOptionValue] -} +""FIXED"" ``` -### SelectedCustomizableOptionValue +### PriceViewEnum -Identifies the value of the selected customized option. +Defines whether a bundle product's price is displayed as the lowest possible value or as a range. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | -| `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | -| `value` - [`String!`](#string) | The text identifying the selected value. | +| `PRICE_RANGE` | | +| `AS_LOW_AS` | | #### Example ```json -{ - "customizable_option_value_uid": "4", - "id": 987, - "label": "xyz789", - "price": CartItemSelectedOptionValuePrice, - "value": "xyz789" -} +""PRICE_RANGE"" ``` -### SelectedPaymentMethod +### ProductAttribute -Describes the payment method the shopper selected. +Contains a product attribute code and value. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. | -| `title` - [`String!`](#string) | The payment method title. | +| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](#string) | The display value of the attribute. | #### Example ```json { "code": "xyz789", - "purchase_order_number": "abc123", - "title": "xyz789" + "value": "abc123" } ``` -### SelectedShippingMethod +### ProductAttributeFilterInput -Contains details about the selected shipping method and carrier. +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 Fields -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | -| `method_title` - [`String!`](#string) | The label for the method code. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| Input Field | Description | +|-------------|-------------| +| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by category URL path. | +| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | +| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | +| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | +| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | #### Example ```json { - "amount": Money, - "base_amount": Money, - "carrier_code": "xyz789", - "carrier_title": "xyz789", - "method_code": "abc123", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money + "category_id": FilterEqualTypeInput, + "category_uid": FilterEqualTypeInput, + "category_url_path": FilterEqualTypeInput, + "description": FilterMatchTypeInput, + "name": FilterMatchTypeInput, + "price": FilterRangeTypeInput, + "short_description": FilterMatchTypeInput, + "sku": FilterEqualTypeInput, + "url_key": FilterEqualTypeInput } ``` -### SendEmailToFriendInput +### ProductAttributeSortInput -Defines the referenced product and the email sender and recipients. +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 #### Input Fields | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | -| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | +| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | #### Example ```json -{ - "product_id": 987, - "recipients": [SendEmailToFriendRecipientInput], - "sender": SendEmailToFriendSenderInput -} +{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} ``` -### SendEmailToFriendOutput +### ProductCustomAttributes -Contains information about the sender and recipients. +Product custom attributes #### Fields | Field Name | Description | |------------|-------------| -| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | #### Example ```json { - "recipients": [SendEmailToFriendRecipient], - "sender": SendEmailToFriendSender + "errors": [AttributeMetadataError], + "items": [AttributeValueInterface] } ``` -### SendEmailToFriendRecipient +### ProductDiscount -An output object that contains information about the recipient. +Contains the discount applied to a product price. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | +| `amount_off` - [`Float`](#float) | The actual value of the discount. | +| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | #### Example ```json -{ - "email": "abc123", - "name": "xyz789" -} +{"amount_off": 123.45, "percent_off": 987.65} ``` -### SendEmailToFriendRecipientInput +### ProductFilterInput -Contains details about a recipient. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | +| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | +| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example ```json { - "email": "abc123", - "name": "xyz789" + "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 } ``` -### SendEmailToFriendSender +### ProductImage -An output object that contains information about the sender. +Contains product image information, including the image URL and label. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | #### Example ```json { - "email": "xyz789", - "message": "xyz789", - "name": "xyz789" + "disabled": false, + "label": "abc123", + "position": 123, + "url": "abc123" } ``` -### SendEmailToFriendSenderInput +### ProductInfoInput -Contains details about the sender. +Product Information used for Pickup Locations search. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | +| `sku` - [`String!`](#string) | Product SKU. | + +#### Example + +```json +{"sku": "abc123"} +``` + + + +### ProductInterface + +Contains fields that are common to all types of products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Possible Types + +| ProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | #### Example ```json { - "email": "abc123", - "message": "xyz789", - "name": "xyz789" + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 123, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "abc123", + "name": "xyz789", + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 123.45, + "related_products": [ProductInterface], + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": false, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "tier_price": 987.65, + "tier_prices": [ProductTierPrices], + "type_id": "xyz789", + "uid": "4", + "updated_at": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website] } ``` -### SendFriendConfiguration +### ProductLinks -Contains details about the configuration of the Email to a Friend feature. +An implementation of `ProductLinksInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | - -#### Example - -```json -{"enabled_for_customers": true, "enabled_for_guests": true} -``` - - - -### SendNegotiableQuoteForReviewInput - -Specifies which negotiable quote to send for review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | #### Example ```json -{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} +{ + "link_type": "xyz789", + "linked_product_sku": "abc123", + "linked_product_type": "abc123", + "position": 987, + "sku": "abc123" +} ``` -### SendNegotiableQuoteForReviewOutput +### ProductLinksInterface -Contains the negotiable quote. +Contains information about linked products, including the link type and product type of each item. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetBillingAddressOnCartInput - -Sets the billing address. +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| ProductLinksInterface Types | +|----------------| +| [`ProductLinks`](#productlinks) | #### Example ```json { - "billing_address": BillingAddressInput, - "cart_id": "abc123" + "link_type": "xyz789", + "linked_product_sku": "xyz789", + "linked_product_type": "xyz789", + "position": 987, + "sku": "xyz789" } ``` -### SetBillingAddressOnCartOutput +### ProductMediaGalleryEntriesContent -Contains details about the cart after setting the billing address. +Contains an image in base64 format and basic information about the image. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetGiftOptionsOnCartInput - -Defines the gift options applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | +| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | +| `name` - [`String`](#string) | The file name of the image. | +| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "cart_id": "abc123", - "gift_message": GiftMessageInput, - "gift_receipt_included": false, - "gift_wrapping_id": "4", - "printed_card_included": true + "base64_encoded_data": "abc123", + "name": "abc123", + "type": "abc123" } ``` -### SetGiftOptionsOnCartOutput +### ProductMediaGalleryEntriesVideoContent -Contains the cart after gift options have been applied. +Contains a link to a video file and basic information about the video. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetGuestEmailOnCartInput - -Defines the guest email and cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `email` - [`String!`](#string) | The email address of the guest. | +| `media_type` - [`String`](#string) | Must be external-video. | +| `video_description` - [`String`](#string) | A description of the video. | +| `video_metadata` - [`String`](#string) | Optional data about the video. | +| `video_provider` - [`String`](#string) | Describes the video source. | +| `video_title` - [`String`](#string) | The title of the video. | +| `video_url` - [`String`](#string) | The URL to the video. | #### Example ```json { - "cart_id": "xyz789", - "email": "abc123" + "media_type": "abc123", + "video_description": "xyz789", + "video_metadata": "abc123", + "video_provider": "abc123", + "video_title": "xyz789", + "video_url": "xyz789" } ``` -### SetGuestEmailOnCartOutput +### ProductPrice -Contains details about the cart after setting the email of a guest. +Represents a product price. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | +| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `regular_price` - [`Money!`](#money) | The regular price of the product. | #### Example ```json -{"cart": Cart} +{ + "discount": ProductDiscount, + "final_price": Money, + "fixed_product_taxes": [FixedProductTax], + "regular_price": Money +} ``` -### SetLineItemNoteOutput +### ProductPrices -Contains the updated negotiable quote. +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 Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuoteBillingAddressInput - -Sets the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | +| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | +| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | #### Example ```json { - "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": 4 + "maximalPrice": Price, + "minimalPrice": Price, + "regularPrice": Price } ``` -### SetNegotiableQuoteBillingAddressOutput +### ProductReview -Contains the negotiable quote. +Contains details of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuotePaymentMethodInput - -Defines the payment method of the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](#string) | The date the review was created. | +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | +| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json { - "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "average_rating": 123.45, + "created_at": "xyz789", + "nickname": "xyz789", + "product": ProductInterface, + "ratings_breakdown": [ProductReviewRating], + "summary": "abc123", + "text": "xyz789" } ``` -### SetNegotiableQuotePaymentMethodOutput +### ProductReviewRating -Contains details about the negotiable quote after setting the payment method. +Contains data about a single aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json -{"quote": NegotiableQuote} +{ + "name": "abc123", + "value": "xyz789" +} ``` -### SetNegotiableQuoteShippingAddressInput +### ProductReviewRatingInput -Defines the shipping address to assign to the negotiable quote. +Contains the reviewer's rating for a single aspect of a review. #### Input Fields | Input Field | Description | |-------------|-------------| -| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| `id` - [`String!`](#string) | An encoded rating ID. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | #### Example ```json { - "customer_address_id": "4", - "quote_uid": 4, - "shipping_addresses": [ - NegotiableQuoteShippingAddressInput - ] + "id": "abc123", + "value_id": "abc123" } ``` -### SetNegotiableQuoteShippingAddressOutput +### ProductReviewRatingMetadata -Contains the negotiable quote. +Contains details about a single aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuoteShippingMethodsInput - -Defines the shipping method to apply to the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | +| `id` - [`String!`](#string) | An encoded rating ID. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | #### Example ```json { - "quote_uid": 4, - "shipping_methods": [ShippingMethodInput] + "id": "xyz789", + "name": "xyz789", + "values": [ProductReviewRatingValueMetadata] } ``` -### SetNegotiableQuoteShippingMethodsOutput +### ProductReviewRatingValueMetadata -Contains the negotiable quote. +Contains details about a single value in a product review. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuoteTemplateShippingAddressInput - -Defines the shipping address to assign to the negotiable quote template. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | #### Example ```json { - "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": "4" + "value": "abc123", + "value_id": "xyz789" } ``` -### SetPaymentMethodAndPlaceOrderInput +### ProductReviewRatingsMetadata -Applies a payment method to the quote. +Contains an array of metadata about each aspect of a product review. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | #### Example ```json -{ - "cart_id": "abc123", - "payment_method": PaymentMethodInput -} +{"items": [ProductReviewRatingMetadata]} ``` -### SetPaymentMethodOnCartInput +### ProductReviews -Applies a payment method to the cart. +Contains an array of product reviews. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | #### Example ```json { - "cart_id": "abc123", - "payment_method": PaymentMethodInput + "items": [ProductReview], + "page_info": SearchResultPageInfo } ``` -### SetPaymentMethodOnCartOutput +### ProductStockStatus -Contains details about the cart after setting the payment method. +This enumeration states whether a product stock status is in stock or out of stock -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `IN_STOCK` | | +| `OUT_OF_STOCK` | | #### Example ```json -{"cart": Cart} +""IN_STOCK"" ``` -### SetShippingAddressesOnCartInput +### ProductTierPrices -Specifies an array of addresses to use for shipping. +Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | +| Field Name | Description | +|------------|-------------| +| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "cart_id": "abc123", - "shipping_addresses": [ShippingAddressInput] + "customer_group_id": "abc123", + "percentage_value": 987.65, + "qty": 123.45, + "value": 987.65, + "website_id": 123.45 } ``` -### SetShippingAddressesOnCartOutput +### ProductVideo -Contains details about the cart after setting the shipping addresses. +Contains information about a product video. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json -{"cart": Cart} +{ + "disabled": false, + "label": "xyz789", + "position": 123, + "url": "xyz789", + "video_content": ProductMediaGalleryEntriesVideoContent +} ``` -### SetShippingMethodsOnCartInput +### Products -Applies one or shipping methods to the cart. +Contains the results of a `products` query. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | +| Field Name | Description | +|------------|-------------| +| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](#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 ```json { - "cart_id": "xyz789", - "shipping_methods": [ShippingMethodInput] + "aggregations": [Aggregation], + "filters": [LayerFilter], + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "suggestions": [SearchSuggestion], + "total_count": 987 } ``` -### SetShippingMethodsOnCartOutput +### PurchaseOrder -Contains details about the cart after setting the shipping methods. +Contains details about a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | +| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | +| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | +| `created_at` - [`String!`](#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | +| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | +| `number` - [`String!`](#string) | The purchase order number. | +| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | +| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | +| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | #### Example ```json -{"cart": Cart} +{ + "approval_flow": [PurchaseOrderRuleApprovalFlow], + "available_actions": ["REJECT"], + "comments": [PurchaseOrderComment], + "created_at": "abc123", + "created_by": Customer, + "history_log": [PurchaseOrderHistoryItem], + "number": "abc123", + "order": CustomerOrder, + "quote": Cart, + "status": "PENDING", + "uid": "4", + "updated_at": "abc123" +} ``` -### ShareGiftRegistryInviteeInput - -Defines a gift registry invitee. +### PurchaseOrderAction -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the gift registry invitee. | -| `name` - [`String!`](#string) | The name of the gift registry invitee. | +| Enum Value | Description | +|------------|-------------| +| `REJECT` | | +| `CANCEL` | | +| `VALIDATE` | | +| `APPROVE` | | +| `PLACE_ORDER` | | #### Example ```json -{ - "email": "abc123", - "name": "xyz789" -} +""REJECT"" ``` -### ShareGiftRegistryOutput +### PurchaseOrderActionError -Contains the results of a request to share a gift registry. +Contains details about a failed action. #### Fields | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{"is_shared": true} +{"message": "xyz789", "type": "NOT_FOUND"} ``` -### ShareGiftRegistrySenderInput +### PurchaseOrderApprovalFlowEvent -Defines the sender of an invitation to view a gift registry. +Contains details about a single event in the approval flow of the purchase order. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `message` - [`String!`](#string) | A brief message from the sender. | -| `name` - [`String!`](#string) | The sender of the gift registry invitation. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | A formatted message. | +| `name` - [`String`](#string) | The approver name. | +| `role` - [`String`](#string) | The approver role. | +| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | +| `updated_at` - [`String`](#string) | The date and time the event was updated. | #### Example ```json { "message": "xyz789", - "name": "xyz789" + "name": "xyz789", + "role": "abc123", + "status": "PENDING", + "updated_at": "xyz789" } ``` -### ShipBundleItemsEnum - -Defines whether bundle items must be shipped together. +### PurchaseOrderApprovalFlowItemStatus #### Values | Enum Value | Description | |------------|-------------| -| `TOGETHER` | | -| `SEPARATELY` | | +| `PENDING` | | +| `APPROVED` | | +| `REJECTED` | | #### Example ```json -""TOGETHER"" +""PENDING"" ``` -### ShipmentItem +### PurchaseOrderApprovalRule + +Contains details about a purchase order approval rule. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | +| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](#string) | The name of the purchase order approval rule. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | #### Example ```json { - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 + "applies_to_roles": [CompanyRole], + "approver_roles": [CompanyRole], + "condition": PurchaseOrderApprovalRuleConditionInterface, + "created_at": "xyz789", + "created_by": "abc123", + "description": "abc123", + "name": "xyz789", + "status": "ENABLED", + "uid": 4, + "updated_at": "xyz789" } ``` -### ShipmentItemInterface +### PurchaseOrderApprovalRuleConditionAmount -Order shipment item details. +Contains approval rule condition details, including the amount to be evaluated. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Possible Types - -| ShipmentItemInterface Types | -|----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | -| [`ShipmentItem`](#shipmentitem) | +| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | #### Example ```json { - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "amount": Money, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN" } ``` -### ShipmentTracking +### PurchaseOrderApprovalRuleConditionInterface -Contains order shipment tracking details. +Purchase order rule condition details. #### Fields | Field Name | Description | |------------|-------------| -| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | -| `number` - [`String`](#string) | The tracking number of the order shipment. | -| `title` - [`String!`](#string) | The shipment tracking title. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | + +#### Possible Types + +| PurchaseOrderApprovalRuleConditionInterface Types | +|----------------| +| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | +| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | #### Example ```json -{ - "carrier": "abc123", - "number": "abc123", - "title": "xyz789" -} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} ``` -### ShippingAddressInput - -Defines a single shipping address. +### PurchaseOrderApprovalRuleConditionOperator -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | +| Enum Value | Description | +|------------|-------------| +| `MORE_THAN` | | +| `LESS_THAN` | | +| `MORE_THAN_OR_EQUAL_TO` | | +| `LESS_THAN_OR_EQUAL_TO` | | #### Example ```json -{ - "address": CartAddressInput, - "customer_address_id": 123, - "customer_notes": "xyz789", - "pickup_location_code": "xyz789" -} +""MORE_THAN"" ``` -### ShippingCartAddress +### PurchaseOrderApprovalRuleConditionQuantity -Contains shipping addresses and methods. +Contains approval rule condition details, including the quantity to be evaluated. #### Fields | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | + +#### Example + +```json +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +``` + + + +### PurchaseOrderApprovalRuleInput + +Defines a new purchase order approval rule. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](#string) | The purchase order approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "available_shipping_methods": [AvailableShippingMethod], - "cart_items": [CartItemQuantity], - "cart_items_v2": [CartItemInterface], - "city": "abc123", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "xyz789", - "items_weight": 123.45, - "lastname": "xyz789", - "middlename": "abc123", - "pickup_location_code": "abc123", - "postcode": "abc123", - "prefix": "abc123", - "region": CartAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", - "uid": "xyz789", - "vat_id": "xyz789" + "applies_to": ["4"], + "approvers": ["4"], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "abc123", + "name": "xyz789", + "status": "ENABLED" } ``` -### ShippingDiscount +### PurchaseOrderApprovalRuleMetadata -Defines an individual shipping discount. This discount can be applied to shipping. +Contains metadata that can be used to render rule edit forms. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example ```json -{"amount": Money} +{ + "available_applies_to": [CompanyRole], + "available_condition_currencies": [AvailableCurrency], + "available_requires_approval_from": [CompanyRole] +} ``` -### ShippingHandling - -Contains details about shipping and handling costs. +### PurchaseOrderApprovalRuleStatus -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | -| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](#money) | The total amount for shipping. | +| `ENABLED` | | +| `DISABLED` | | #### Example ```json -{ - "amount_excluding_tax": Money, - "amount_including_tax": Money, - "discounts": [ShippingDiscount], - "taxes": [TaxItem], - "total_amount": Money -} +""ENABLED"" ``` -### ShippingMethodInput - -Defines the shipping carrier and method. +### PurchaseOrderApprovalRuleType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | -| `method_code` - [`String!`](#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. | +| Enum Value | Description | +|------------|-------------| +| `GRAND_TOTAL` | | +| `SHIPPING_INCL_TAX` | | +| `NUMBER_OF_SKUS` | | #### Example ```json -{ - "carrier_code": "abc123", - "method_code": "xyz789" -} +""GRAND_TOTAL"" ``` -### SimpleCartItem +### PurchaseOrderApprovalRules -An implementation for simple product cart items. +Contains the approval rules that the customer can see. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | #### Example ```json { - "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": 123.45, - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "items": [PurchaseOrderApprovalRule], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### SimpleProduct +### PurchaseOrderComment -Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. +Contains details about a comment. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `author` - [`Customer`](#customer) | The user who left the comment. | +| `created_at` - [`String!`](#string) | The date and time when the comment was created. | +| `text` - [`String!`](#string) | The text of the comment. | +| `uid` - [`ID!`](#id) | A unique identifier of the comment. | #### Example ```json { - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": "xyz789", - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "abc123", - "staged": true, - "stock_status": "IN_STOCK", - "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": "abc123", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 123.45 + "author": Customer, + "created_at": "xyz789", + "text": "xyz789", + "uid": "4" } ``` -### SimpleProductCartItemInput - -Defines a single product to add to the cart. +### PurchaseOrderErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| Enum Value | Description | +|------------|-------------| +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | #### Example ```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} +""NOT_FOUND"" ``` -### SimpleRequisitionListItem +### PurchaseOrderHistoryItem -Contains details about simple products added to a requisition list. +Contains details about a status change. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `activity` - [`String!`](#string) | The activity type of the event. | +| `created_at` - [`String!`](#string) | The date and time when the event happened. | +| `message` - [`String!`](#string) | The message representation of the event. | +| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, + "activity": "abc123", + "created_at": "abc123", + "message": "xyz789", "uid": "4" } ``` -### SimpleWishlistItem +### PurchaseOrderRuleApprovalFlow -Contains a simple product wish list item. +Contains details about approval roles applied to the purchase order and status changes. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | +| `rule_name` - [`String!`](#string) | The name of the applied rule. | #### Example ```json { - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 + "events": [PurchaseOrderApprovalFlowEvent], + "rule_name": "abc123" } ``` -### SmartButtonMethodInput - -Smart button payment inputs +### PurchaseOrderStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVAL_REQUIRED` | | +| `APPROVED` | | +| `ORDER_IN_PROGRESS` | | +| `ORDER_PLACED` | | +| `ORDER_FAILED` | | +| `REJECTED` | | +| `CANCELED` | | +| `APPROVED_PENDING_PAYMENT` | | #### Example ```json -{ - "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" -} +""PENDING"" ``` -### SmartButtonsConfig +### PurchaseOrders + +Contains a list of purchase orders. #### Fields | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | +| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | #### Example ```json { - "button_styles": ButtonStyles, - "code": "xyz789", - "display_message": true, - "display_venmo": false, - "is_visible": false, - "message_styles": MessageStyles, - "payment_intent": "abc123", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" + "items": [PurchaseOrder], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### SortEnum +### PurchaseOrdersActionInput -Indicates whether to return results in ascending or descending order. +Defines which purchase orders to act on. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `ASC` | | -| `DESC` | | +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | #### Example ```json -""ASC"" +{"purchase_order_uids": ["4"]} ``` -### SortField +### PurchaseOrdersActionOutput -Defines a possible sort field. +Returns a list of updated purchase orders and any error messages. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label of the sort field. | -| `value` - [`String`](#string) | The attribute code of the sort field. | +| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | #### Example ```json { - "label": "abc123", - "value": "xyz789" + "errors": [PurchaseOrderActionError], + "purchase_orders": [PurchaseOrder] } ``` -### SortFields +### PurchaseOrdersFilterInput -Contains a default value for sort fields and all available sort fields. +Defines the criteria to use to filter the list of purchase orders. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `default` - [`String`](#string) | The default sort field value. | -| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | +| Input Field | Description | +|-------------|-------------| +| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | #### Example ```json { - "default": "xyz789", - "options": [SortField] + "company_purchase_orders": false, + "created_date": FilterRangeTypeInput, + "require_my_approval": true, + "status": "PENDING" } ``` - -### SortQuoteItemsEnum - -Specifies the field to use for sorting quote items - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""ITEM_ID"" -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-q-s.md new file mode 100644 index 000000000..a4fc93572 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-q-s.md @@ -0,0 +1,4002 @@ +## Types + +### QuoteItemsSortInput + +Specifies the field to use for sorting quote items + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | +| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | + +#### Example + +```json +{"field": "ITEM_ID", "order": "ASC"} +``` + + + +### QuoteTemplateLineItemNoteInput + +Sets quote item note. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `note` - [`String`](#string) | The note text to be added. | +| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "item_id": 4, + "note": "xyz789", + "templateId": 4 +} +``` + + + +### QuoteTemplateNotificationMessage + +Contains a notification message for a negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The notification message. | +| `type` - [`String!`](#string) | The type of notification message. | + +#### Example + +```json +{ + "message": "abc123", + "type": "xyz789" +} +``` + + + +### ReCaptchaConfigurationV3 + +Contains reCAPTCHA V3-Invisible configuration details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | +| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | + +#### Example + +```json +{ + "badge_position": "xyz789", + "failure_message": "abc123", + "forms": ["PLACE_ORDER"], + "is_enabled": false, + "language_code": "xyz789", + "minimum_score": 123.45, + "website_key": "abc123" +} +``` + + + +### ReCaptchaFormEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PLACE_ORDER` | | +| `CONTACT` | | +| `CUSTOMER_LOGIN` | | +| `CUSTOMER_FORGOT_PASSWORD` | | +| `CUSTOMER_CREATE` | | +| `CUSTOMER_EDIT` | | +| `NEWSLETTER` | | +| `PRODUCT_REVIEW` | | +| `SENDFRIEND` | | +| `BRAINTREE` | | + +#### Example + +```json +""PLACE_ORDER"" +``` + + + +### Region + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | +| `id` - [`Int`](#int) | The unique ID for a `Region` object. | +| `name` - [`String`](#string) | The name of the region, such as Texas. | + +#### Example + +```json +{ + "code": "xyz789", + "id": 987, + "name": "xyz789" +} +``` + + + +### RemoveCouponFromCartInput + +Specifies the cart from which to remove a coupon. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### RemoveCouponFromCartOutput + +Contains details about the cart after removing a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveCouponsFromCartInput + +Remove coupons from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#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 + +```json +{ + "cart_id": "xyz789", + "coupon_codes": ["xyz789"] +} +``` + + + +### RemoveGiftCardFromCartInput + +Defines the input required to run the `removeGiftCardFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_card_code": "xyz789" +} +``` + + + +### RemoveGiftCardFromCartOutput + +Defines the possible output for the `removeGiftCardFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveGiftRegistryItemsOutput + +Contains the results of a request to remove an item from a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveGiftRegistryOutput + +Contains the results of a request to delete a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | + +#### Example + +```json +{"success": true} +``` + + + +### RemoveGiftRegistryRegistrantsOutput + +Contains the results of a request to delete a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveItemFromCartInput + +Specifies which items to remove from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_item_id": 123, + "cart_item_uid": 4 +} +``` + + + +### RemoveItemFromCartOutput + +Contains details about the cart after removing an item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after removing an item. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveNegotiableQuoteItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "quote_item_uids": ["4"], + "quote_uid": "4" +} +``` + + + +### RemoveNegotiableQuoteItemsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RemoveNegotiableQuoteTemplateItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "item_uids": ["4"], + "template_id": "4" +} +``` + + + +### RemoveProductsFromCompareListInput + +Defines which products to remove from a compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{ + "products": ["4"], + "uid": "4" +} +``` + + + +### RemoveProductsFromWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### RemoveReturnTrackingInput + +Defines the tracking information to delete. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | + +#### Example + +```json +{"return_shipping_tracking_uid": 4} +``` + + + +### RemoveReturnTrackingOutput + +Contains the response after deleting tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Contains details about the modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### RemoveRewardPointsFromCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveStoreCreditFromCartInput + +Defines the input required to run the `removeStoreCreditFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### RemoveStoreCreditFromCartOutput + +Defines the possible output for the `removeStoreCreditFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RenameNegotiableQuoteInput + +Sets new name for a negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | +| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | +| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | + +#### Example + +```json +{ + "quote_comment": "abc123", + "quote_name": "abc123", + "quote_uid": "4" +} +``` + + + +### RenameNegotiableQuoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### ReorderItemsOutput + +Contains the cart and any errors after adding products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | + +#### Example + +```json +{ + "cart": Cart, + "userInputErrors": [CheckoutUserInputError] +} +``` + + + +### RequestNegotiableQuoteInput + +Defines properties of a negotiable quote request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | +| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | + +#### Example + +```json +{ + "cart_id": 4, + "comment": NegotiableQuoteCommentInput, + "is_draft": false, + "quote_name": "abc123" +} +``` + + + +### RequestNegotiableQuoteOutput + +Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RequestNegotiableQuoteTemplateInput + +Defines properties of a negotiable quote template request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | + +#### Example + +```json +{"cart_id": "4"} +``` + + + +### RequestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | + +#### Example + +```json +{ + "comment_text": "xyz789", + "contact_email": "xyz789", + "items": [RequestReturnItemInput], + "order_uid": "4" +} +``` + + + +### RequestReturnItemInput + +Contains details about an item to be returned. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | +| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 + +```json +{ + "entered_custom_attributes": [ + EnteredCustomAttributeInput + ], + "order_item_uid": "4", + "quantity_to_return": 987.65, + "selected_custom_attributes": [ + SelectedCustomAttributeInput + ] +} +``` + + + +### RequestReturnOutput + +Contains the response to a return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about a single return request. | +| `returns` - [`Returns`](#returns) | An array of return requests. | + +#### Example + +```json +{ + "return": Return, + "returns": Returns +} +``` + + + +### RequisitionList + +Defines the contents of a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `description` - [`String`](#string) | Optional text that describes the requisition list. | +| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | +| `items_count` - [`Int!`](#int) | The number of items in the list. | +| `name` - [`String!`](#string) | The requisition list name. | +| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | + +#### Example + +```json +{ + "description": "xyz789", + "items": RequistionListItems, + "items_count": 987, + "name": "abc123", + "uid": 4, + "updated_at": "abc123" +} +``` + + + +### RequisitionListFilterInput + +Defines requisition list filters. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | + +#### Example + +```json +{ + "name": FilterMatchTypeInput, + "uids": FilterEqualTypeInput +} +``` + + + +### RequisitionListItemInterface + +The interface for requisition list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Possible Types + +| RequisitionListItemInterface Types | +|----------------| +| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | +| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### RequisitionListItemsInput + +Defines the items to add. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | +| `quantity` - [`Float`](#float) | The quantity of the product to add. | +| `selected_options` - [`[String]`](#string) | Selected option IDs. | +| `sku` - [`String!`](#string) | The product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 123.45, + "selected_options": ["xyz789"], + "sku": "xyz789" +} +``` + + + +### RequisitionLists + +Defines customer requisition lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The number of returned requisition lists. | + +#### Example + +```json +{ + "items": [RequisitionList], + "page_info": SearchResultPageInfo, + "total_count": 987 +} +``` + + + +### RequistionListItems + +Contains an array of items added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_pages` - [`Int!`](#int) | The number of pages returned. | + +#### Example + +```json +{ + "items": [RequisitionListItemInterface], + "page_info": SearchResultPageInfo, + "total_pages": 987 +} +``` + + + +### Return + +Contains details about a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | +| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | +| `created_at` - [`String!`](#string) | The date the return was requested. | +| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | +| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | +| `number` - [`String!`](#string) | A human-readable return number. | +| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | +| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | +| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | +| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "available_shipping_carriers": [ReturnShippingCarrier], + "comments": [ReturnComment], + "created_at": "abc123", + "customer": ReturnCustomer, + "items": [ReturnItem], + "number": "xyz789", + "order": CustomerOrder, + "shipping": ReturnShipping, + "status": "PENDING", + "uid": "4" +} +``` + + + +### ReturnComment + +Contains details about a return comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author_name` - [`String!`](#string) | The name or author who posted the comment. | +| `created_at` - [`String!`](#string) | The date and time the comment was posted. | +| `text` - [`String!`](#string) | The contents of the comment. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | + +#### Example + +```json +{ + "author_name": "abc123", + "created_at": "xyz789", + "text": "xyz789", + "uid": "4" +} +``` + + + +### ReturnCustomAttribute + +Contains details about a `ReturnCustomerAttribute` object. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the attribute. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": 4, + "value": "abc123" +} +``` + + + +### ReturnCustomer + +The customer information for the return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the customer. | +| `firstname` - [`String`](#string) | The first name of the customer. | +| `lastname` - [`String`](#string) | The last name of the customer. | + +#### Example + +```json +{ + "email": "abc123", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### ReturnItem + +Contains details about a product being returned. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. *(Deprecated: Use custom_attributesV2 instead.)* | +| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | +| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | + +#### Example + +```json +{ + "custom_attributes": [ReturnCustomAttribute], + "custom_attributesV2": [AttributeValueInterface], + "order_item": OrderItemInterface, + "quantity": 123.45, + "request_quantity": 123.45, + "status": "PENDING", + "uid": "4" +} +``` + + + +### ReturnItemAttributeMetadata + +Return Item attribute metadata. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | + +#### Example + +```json +{ + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "abc123", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": false, + "is_unique": true, + "label": "abc123", + "multiline_count": 987, + "options": [CustomAttributeOptionInterface], + "sort_order": 987, + "validate_rules": [ValidationRule] +} +``` + + + +### ReturnItemStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `RECEIVED` | | +| `APPROVED` | | +| `REJECTED` | | +| `DENIED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### ReturnShipping + +Contains details about the return shipping address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | +| `tracking` - [`[ReturnShippingTracking]`](#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. | + +#### Example + +```json +{ + "address": ReturnShippingAddress, + "tracking": [ReturnShippingTracking] +} +``` + + + +### ReturnShippingAddress + +Contains details about the shipping address used for receiving returned items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city for product returns. | +| `contact_name` - [`String`](#string) | The merchant's contact person. | +| `country` - [`Country!`](#country) | An object that defines the country for product returns. | +| `postcode` - [`String!`](#string) | The postal code for product returns. | +| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | +| `street` - [`[String]!`](#string) | The street address for product returns. | +| `telephone` - [`String`](#string) | The telephone number for product returns. | + +#### Example + +```json +{ + "city": "abc123", + "contact_name": "xyz789", + "country": Country, + "postcode": "abc123", + "region": Region, + "street": ["xyz789"], + "telephone": "abc123" +} +``` + + + +### ReturnShippingCarrier + +Contains details about the carrier on a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the shipping carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": "4" +} +``` + + + +### ReturnShippingTracking + +Contains shipping and tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | +| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | +| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | + +#### Example + +```json +{ + "carrier": ReturnShippingCarrier, + "status": ReturnShippingTrackingStatus, + "tracking_number": "abc123", + "uid": 4 +} +``` + + + +### ReturnShippingTrackingStatus + +Contains the status of a shipment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `text` - [`String!`](#string) | Text that describes the status. | +| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | + +#### Example + +```json +{"text": "abc123", "type": "INFORMATION"} +``` + + + +### ReturnShippingTrackingStatusType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INFORMATION` | | +| `ERROR` | | + +#### Example + +```json +""INFORMATION"" +``` + + + +### ReturnStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `PARTIALLY_AUTHORIZED` | | +| `RECEIVED` | | +| `PARTIALLY_RECEIVED` | | +| `APPROVED` | | +| `PARTIALLY_APPROVED` | | +| `REJECTED` | | +| `PARTIALLY_REJECTED` | | +| `DENIED` | | +| `PROCESSED_AND_CLOSED` | | +| `CLOSED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### Returns + +Contains a list of customer return requests. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Return]`](#return) | A list of return requests. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The total number of return requests. | + +#### Example + +```json +{ + "items": [Return], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### RevokeCustomerTokenOutput + +Contains the result of a request to revoke a customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | + +#### Example + +```json +{"result": false} +``` + + + +### RewardPoints + +Contains details about a customer's reward points. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | +| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | +| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "balance_history": [RewardPointsBalanceHistoryItem], + "exchange_rates": RewardPointsExchangeRates, + "subscription_status": RewardPointsSubscriptionStatus +} +``` + + + +### RewardPointsAmount + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `money` - [`Money!`](#money) | The reward points amount in store currency. | +| `points` - [`Float!`](#float) | The reward points amount in points. | + +#### Example + +```json +{"money": Money, "points": 123.45} +``` + + + +### RewardPointsBalanceHistoryItem + +Contain details about the reward points transaction. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | +| `change_reason` - [`String!`](#string) | The reason the balance changed. | +| `date` - [`String!`](#string) | The date of the transaction. | +| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "change_reason": "xyz789", + "date": "xyz789", + "points_change": 987.65 +} +``` + + + +### RewardPointsExchangeRates + +Lists the reward points exchange rates. The values depend on the customer group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | +| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | + +#### Example + +```json +{ + "earning": RewardPointsRate, + "redemption": RewardPointsRate +} +``` + + + +### RewardPointsRate + +Contains details about customer's reward points rate. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency_amount` - [`Float!`](#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!`](#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 + +```json +{"currency_amount": 987.65, "points": 987.65} +``` + + + +### RewardPointsSubscriptionStatus + +Indicates whether the customer subscribes to reward points emails. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | +| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | + +#### Example + +```json +{ + "balance_updates": "SUBSCRIBED", + "points_expiration_notifications": "SUBSCRIBED" +} +``` + + + +### RewardPointsSubscriptionStatusesEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUBSCRIBED` | | +| `NOT_SUBSCRIBED` | | + +#### Example + +```json +""SUBSCRIBED"" +``` + + + +### RoutableInterface + +Routable entities serve as the model for a rendered page. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Possible Types + +| RoutableInterface Types | +|----------------| +| [`CmsPage`](#cmspage) | +| [`CategoryTree`](#categorytree) | +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`RoutableUrl`](#routableurl) | + +#### Example + +```json +{ + "redirect_code": 987, + "relative_url": "xyz789", + "type": "CMS_PAGE" +} +``` + + + +### RoutableUrl + +Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Example + +```json +{ + "redirect_code": 987, + "relative_url": "xyz789", + "type": "CMS_PAGE" +} +``` + + + +### SDKParams + +Defines the name and value of a SDK parameter + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | The name of the SDK parameter | +| `value` - [`String`](#string) | The value of the SDK parameter | + +#### Example + +```json +{ + "name": "xyz789", + "value": "xyz789" +} +``` + + + +### SalesCommentItem + +Contains details about a comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The text of the message. | +| `timestamp` - [`String!`](#string) | The timestamp of the comment. | + +#### Example + +```json +{ + "message": "abc123", + "timestamp": "abc123" +} +``` + + + +### ScopeTypeEnum + +This enumeration defines the scope type for customer orders. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `GLOBAL` | | +| `WEBSITE` | | +| `STORE` | | + +#### Example + +```json +""GLOBAL"" +``` + + + +### SearchResultPageInfo + +Provides navigation for the query response. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `current_page` - [`Int`](#int) | The specific page to return. | +| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](#int) | The total number of pages in the response. | + +#### Example + +```json +{"current_page": 123, "page_size": 987, "total_pages": 123} +``` + + + +### SearchSuggestion + +A string that contains search suggestion + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `search` - [`String!`](#string) | The search suggestion of existing product. | + +#### Example + +```json +{"search": "abc123"} +``` + + + +### SelectedBundleOption + +Contains details about a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `label` - [`String!`](#string) | The display name of the selected bundle product option. | +| `type` - [`String!`](#string) | The type of selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | +| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | + +#### Example + +```json +{ + "id": 123, + "label": "xyz789", + "type": "xyz789", + "uid": 4, + "values": [SelectedBundleOptionValue] +} +``` + + + +### SelectedBundleOptionValue + +Contains details about a value for a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`Int!`](#int) | Use `uid` instead | +| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | +| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | + +#### Example + +```json +{ + "id": 123, + "label": "xyz789", + "price": 123.45, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### SelectedConfigurableOption + +Contains details about a selected configurable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `option_label` - [`String!`](#string) | The display text for the option. | +| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | + +#### Example + +```json +{ + "configurable_product_option_uid": "4", + "configurable_product_option_value_uid": "4", + "id": 123, + "option_label": "xyz789", + "value_id": 987, + "value_label": "abc123" +} +``` + + + +### SelectedCustomAttributeInput + +Contains details about an attribute the buyer selected. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | +| `value` - [`ID!`](#id) | The unique ID for a `CustomAttribute` object of a selected custom attribute. | + +#### Example + +```json +{"attribute_code": "xyz789", "value": 4} +``` + + + +### SelectedCustomizableOption + +Identifies a customized product that has been placed in a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | +| `label` - [`String!`](#string) | The display name of the selected customizable option. | +| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | +| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | +| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | + +#### Example + +```json +{ + "customizable_option_uid": 4, + "id": 987, + "is_required": false, + "label": "abc123", + "sort_order": 123, + "type": "abc123", + "values": [SelectedCustomizableOptionValue] +} +``` + + + +### SelectedCustomizableOptionValue + +Identifies the value of the selected customized option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `label` - [`String!`](#string) | The display name of the selected value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `value` - [`String!`](#string) | The text identifying the selected value. | + +#### Example + +```json +{ + "customizable_option_value_uid": "4", + "id": 987, + "label": "abc123", + "price": CartItemSelectedOptionValuePrice, + "value": "xyz789" +} +``` + + + +### SelectedPaymentMethod + +Describes the payment method the shopper selected. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "purchase_order_number": "xyz789", + "title": "abc123" +} +``` + + + +### SelectedShippingMethod + +Contains details about the selected shipping method and carrier. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | +| `method_title` - [`String!`](#string) | The label for the method code. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "base_amount": Money, + "carrier_code": "abc123", + "carrier_title": "abc123", + "method_code": "abc123", + "method_title": "abc123", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### SendEmailToFriendInput + +Defines the referenced product and the email sender and recipients. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "product_id": 987, + "recipients": [SendEmailToFriendRecipientInput], + "sender": SendEmailToFriendSenderInput +} +``` + + + +### SendEmailToFriendOutput + +Contains information about the sender and recipients. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "recipients": [SendEmailToFriendRecipient], + "sender": SendEmailToFriendSender +} +``` + + + +### SendEmailToFriendRecipient + +An output object that contains information about the recipient. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | + +#### Example + +```json +{ + "email": "abc123", + "name": "abc123" +} +``` + + + +### SendEmailToFriendRecipientInput + +Contains details about a recipient. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "xyz789" +} +``` + + + +### SendEmailToFriendSender + +An output object that contains information about the sender. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "abc123", + "message": "abc123", + "name": "xyz789" +} +``` + + + +### SendEmailToFriendSenderInput + +Contains details about the sender. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "abc123", + "message": "abc123", + "name": "abc123" +} +``` + + + +### SendFriendConfiguration + +Contains details about the configuration of the Email to a Friend feature. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | + +#### Example + +```json +{"enabled_for_customers": true, "enabled_for_guests": false} +``` + + + +### SendNegotiableQuoteForReviewInput + +Specifies which negotiable quote to send for review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "comment": NegotiableQuoteCommentInput, + "quote_uid": "4" +} +``` + + + +### SendNegotiableQuoteForReviewOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetBillingAddressOnCartInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{ + "billing_address": BillingAddressInput, + "cart_id": "abc123" +} +``` + + + +### SetBillingAddressOnCartOutput + +Contains details about the cart after setting the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGiftOptionsOnCartInput + +Defines the gift options applied to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "gift_message": GiftMessageInput, + "gift_receipt_included": true, + "gift_wrapping_id": 4, + "printed_card_included": false +} +``` + + + +### SetGiftOptionsOnCartOutput + +Contains the cart after gift options have been applied. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The modified cart object. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGuestEmailOnCartInput + +Defines the guest email and cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `email` - [`String!`](#string) | The email address of the guest. | + +#### Example + +```json +{ + "cart_id": "abc123", + "email": "xyz789" +} +``` + + + +### SetGuestEmailOnCartOutput + +Contains details about the cart after setting the email of a guest. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetLineItemNoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteBillingAddressInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "billing_address": NegotiableQuoteBillingAddressInput, + "quote_uid": "4" +} +``` + + + +### SetNegotiableQuoteBillingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuotePaymentMethodInput + +Defines the payment method of the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "payment_method": NegotiableQuotePaymentMethodInput, + "quote_uid": 4 +} +``` + + + +### SetNegotiableQuotePaymentMethodOutput + +Contains details about the negotiable quote after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingAddressInput + +Defines the shipping address to assign to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | + +#### Example + +```json +{ + "customer_address_id": "4", + "quote_uid": "4", + "shipping_addresses": [ + NegotiableQuoteShippingAddressInput + ] +} +``` + + + +### SetNegotiableQuoteShippingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingMethodsInput + +Defines the shipping method to apply to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | + +#### Example + +```json +{ + "quote_uid": 4, + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetNegotiableQuoteShippingMethodsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteTemplateShippingAddressInput + +Defines the shipping address to assign to the negotiable quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "shipping_address": NegotiableQuoteTemplateShippingAddressInput, + "template_id": 4 +} +``` + + + +### SetPaymentMethodAndPlaceOrderInput + +Applies a payment method to the quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartInput + +Applies a payment method to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartOutput + +Contains details about the cart after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingAddressesOnCartInput + +Specifies an array of addresses to use for shipping. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "shipping_addresses": [ShippingAddressInput] +} +``` + + + +### SetShippingAddressesOnCartOutput + +Contains details about the cart after setting the shipping addresses. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingMethodsOnCartInput + +Applies one or shipping methods to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | + +#### Example + +```json +{ + "cart_id": "abc123", + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetShippingMethodsOnCartOutput + +Contains details about the cart after setting the shipping methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ShareGiftRegistryInviteeInput + +Defines a gift registry invitee. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the gift registry invitee. | +| `name` - [`String!`](#string) | The name of the gift registry invitee. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "abc123" +} +``` + + + +### ShareGiftRegistryOutput + +Contains the results of a request to share a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | + +#### Example + +```json +{"is_shared": false} +``` + + + +### ShareGiftRegistrySenderInput + +Defines the sender of an invitation to view a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `message` - [`String!`](#string) | A brief message from the sender. | +| `name` - [`String!`](#string) | The sender of the gift registry invitation. | + +#### Example + +```json +{ + "message": "xyz789", + "name": "abc123" +} +``` + + + +### ShipBundleItemsEnum + +Defines whether bundle items must be shipped together. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TOGETHER` | | +| `SEPARATELY` | | + +#### Example + +```json +""TOGETHER"" +``` + + + +### ShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### ShipmentItemInterface + +Order shipment item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Possible Types + +| ShipmentItemInterface Types | +|----------------| +| [`BundleShipmentItem`](#bundleshipmentitem) | +| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`ShipmentItem`](#shipmentitem) | + +#### Example + +```json +{ + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### ShipmentTracking + +Contains order shipment tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | +| `number` - [`String`](#string) | The tracking number of the order shipment. | +| `title` - [`String!`](#string) | The shipment tracking title. | + +#### Example + +```json +{ + "carrier": "abc123", + "number": "abc123", + "title": "abc123" +} +``` + + + +### ShippingAddressInput + +Defines a single shipping address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 123, + "customer_notes": "xyz789", + "pickup_location_code": "xyz789" +} +``` + + + +### ShippingCartAddress + +Contains shipping addresses and methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "available_shipping_methods": [AvailableShippingMethod], + "cart_items": [CartItemQuantity], + "cart_items_v2": [CartItemInterface], + "city": "xyz789", + "company": "xyz789", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "xyz789", + "items_weight": 123.45, + "lastname": "xyz789", + "middlename": "xyz789", + "pickup_location_code": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CartAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": "abc123", + "vat_id": "xyz789" +} +``` + + + +### ShippingDiscount + +Defines an individual shipping discount. This discount can be applied to shipping. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | + +#### Example + +```json +{"amount": Money} +``` + + + +### ShippingHandling + +Contains details about shipping and handling costs. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | +| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](#money) | The total amount for shipping. | + +#### Example + +```json +{ + "amount_excluding_tax": Money, + "amount_including_tax": Money, + "discounts": [ShippingDiscount], + "taxes": [TaxItem], + "total_amount": Money +} +``` + + + +### ShippingMethodInput + +Defines the shipping carrier and method. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | +| `method_code` - [`String!`](#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 + +```json +{ + "carrier_code": "xyz789", + "method_code": "abc123" +} +``` + + + +### SimpleCartItem + +An implementation for simple product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "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": 123.45, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### SimpleProduct + +Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": "xyz789", + "id": 123, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 987, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "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": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### SimpleProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### SimpleRequisitionListItem + +Contains details about simple products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### SimpleWishlistItem + +Contains a simple product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### SmartButtonMethodInput + +Smart button payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "abc123", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### SmartButtonsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": ButtonStyles, + "code": "xyz789", + "display_message": true, + "display_venmo": false, + "is_visible": true, + "message_styles": MessageStyles, + "payment_intent": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "xyz789" +} +``` + + + +### SortEnum + +Indicates whether to return results in ascending or descending order. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ASC` | | +| `DESC` | | + +#### Example + +```json +""ASC"" +``` + + + +### SortField + +Defines a possible sort field. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label of the sort field. | +| `value` - [`String`](#string) | The attribute code of the sort field. | + +#### Example + +```json +{ + "label": "abc123", + "value": "xyz789" +} +``` + + + +### SortFields + +Contains a default value for sort fields and all available sort fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `default` - [`String`](#string) | The default sort field value. | +| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | + +#### Example + +```json +{ + "default": "xyz789", + "options": [SortField] +} +``` + + + +### SortQuoteItemsEnum + +Specifies the field to use for sorting quote items + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ITEM_ID"" +``` + + + +### StoreConfig + +Contains information about a store's configuration. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `` tag. | +| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | +| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | +| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | +| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | +| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `base_currency_code` - [`String`](#string) | The base currency code. | +| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | +| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | +| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | +| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | +| `braintree_3dsecure_allowspecific` - [`Boolean`](#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](#boolean) | Braintree 3D Secure, always request 3D Secure flag. | +| `braintree_3dsecure_specificcountry` - [`String`](#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`](#string) | Braintree 3D Secure, threshold above which 3D Secure should be requested. | +| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](#boolean) | Braintree ACH vault status. | +| `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | +| `braintree_applepay_vault_active` - [`Boolean`](#boolean) | Braintree Apple Pay vault status. | +| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | +| `braintree_cc_vault_cvv` - [`Boolean`](#boolean) | Braintree cc vault CVV re-verification enabled status. | +| `braintree_environment` - [`String`](#string) | Braintree environment. | +| `braintree_googlepay_btn_color` - [`String`](#string) | Braintree Google Pay button color. | +| `braintree_googlepay_cctypes` - [`String`](#string) | Braintree Google Pay Card types supported. | +| `braintree_googlepay_merchant_id` - [`String`](#string) | Braintree Google Pay merchant ID. | +| `braintree_googlepay_vault_active` - [`Boolean`](#boolean) | Braintree Google Pay vault status. | +| `braintree_local_payment_allowed_methods` - [`String`](#string) | Braintree Local Payment Methods allowed payment methods. | +| `braintree_local_payment_fallback_button_text` - [`String`](#string) | Braintree Local Payment Methods fallback button text. | +| `braintree_local_payment_redirect_on_fail` - [`String`](#string) | Braintree Local Payment Methods redirect URL on failed payment. | +| `braintree_merchant_account_id` - [`String`](#string) | Braintree Merchant Account ID. | +| `braintree_paypal_button_location_cart_type_credit_color` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_credit_label` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style layout. | +| `braintree_paypal_button_location_cart_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo. | +| `braintree_paypal_button_location_cart_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo position. | +| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | +| `braintree_paypal_button_location_cart_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | +| `braintree_paypal_button_location_cart_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_paypal_color` - [`String`](#string) | Braintree PayPal mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_paypal_label` - [`String`](#string) | Braintree PayPal mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_paypal_shape` - [`String`](#string) | Braintree PayPal mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal mini-cart & cart button show. | +| `braintree_paypal_button_location_checkout_type_credit_color` - [`String`](#string) | Braintree PayPal Credit checkout button style color. | +| `braintree_paypal_button_location_checkout_type_credit_label` - [`String`](#string) | Braintree PayPal Credit checkout button style label. | +| `braintree_paypal_button_location_checkout_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit checkout button show status. | +| `braintree_paypal_button_location_checkout_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style layout. | +| `braintree_paypal_button_location_checkout_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo. | +| `braintree_paypal_button_location_checkout_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo position. | +| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging checkout show status. | +| `braintree_paypal_button_location_checkout_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | +| `braintree_paypal_button_location_checkout_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later checkout button style color. | +| `braintree_paypal_button_location_checkout_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later checkout button style label. | +| `braintree_paypal_button_location_checkout_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later checkout button show status. | +| `braintree_paypal_button_location_checkout_type_paypal_color` - [`String`](#string) | Braintree PayPal checkout button style color. | +| `braintree_paypal_button_location_checkout_type_paypal_label` - [`String`](#string) | Braintree PayPal checkout button style label. | +| `braintree_paypal_button_location_checkout_type_paypal_shape` - [`String`](#string) | Braintree PayPal checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal checkout button show. | +| `braintree_paypal_button_location_productpage_type_credit_color` - [`String`](#string) | Braintree PayPal Credit PDP button style color. | +| `braintree_paypal_button_location_productpage_type_credit_label` - [`String`](#string) | Braintree PayPal Credit PDP button style label. | +| `braintree_paypal_button_location_productpage_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit PDP button show status. | +| `braintree_paypal_button_location_productpage_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style layout. | +| `braintree_paypal_button_location_productpage_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo. | +| `braintree_paypal_button_location_productpage_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo position. | +| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging PDP show status. | +| `braintree_paypal_button_location_productpage_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style text color. | +| `braintree_paypal_button_location_productpage_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later PDP button style color. | +| `braintree_paypal_button_location_productpage_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later PDP button style label. | +| `braintree_paypal_button_location_productpage_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later PDP button show status. | +| `braintree_paypal_button_location_productpage_type_paypal_color` - [`String`](#string) | Braintree PayPal PDP button style color. | +| `braintree_paypal_button_location_productpage_type_paypal_label` - [`String`](#string) | Braintree PayPal PDP button style label. | +| `braintree_paypal_button_location_productpage_type_paypal_shape` - [`String`](#string) | Braintree PayPal PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal PDP button show. | +| `braintree_paypal_credit_uk_merchant_name` - [`String`](#string) | Braintree PayPal Credit Merchant Name on the FCA Register. | +| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](#boolean) | Should display Braintree PayPal in mini-cart & cart? | +| `braintree_paypal_merchant_country` - [`String`](#string) | Braintree PayPal merchant's country. | +| `braintree_paypal_merchant_name_override` - [`String`](#string) | Braintree PayPal override for Merchant Name. | +| `braintree_paypal_require_billing_address` - [`Boolean`](#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](#int) | Extended Config Data - checkout/cart/delete_quote_after | +| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | +| `cart_printed_card` - [`String`](#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`](#int) | Extended Config Data - checkout/cart_link/use_qty | +| `catalog_default_sort_by` - [`String`](#string) | The default sort order of the search results list. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | +| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | +| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | +| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | +| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | +| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | +| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | +| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | +| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | +| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | +| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | +| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | +| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | +| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | +| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | +| `default_description` - [`String`](#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`](#string) | The default display currency code. | +| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | +| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | +| `demonotice` - [`Int`](#int) | Controls the display of the demo store notice at the top of the page. Options: 0 (No) or 1 (Yes). | +| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | +| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | +| `front` - [`String`](#string) | The landing page that is associated with the base URL. | +| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | +| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | +| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `` tag. | +| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | +| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | +| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | Extended Config Data - checkout/options/guest_checkout | +| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | Extended Config Data - checkout/options/onepage_checkout_enabled | +| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | +| `list_mode` - [`String`](#string) | The format of the search results list. | +| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | +| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | +| `locale` - [`String`](#string) | The store locale. | +| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | +| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | +| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | +| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | +| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | +| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | +| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | +| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | +| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | +| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | +| `max_items_in_order_summary` - [`Int`](#int) | Extended Config Data - checkout/options/max_items_display_count | +| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | +| `minicart_display` - [`Boolean`](#boolean) | Extended Config Data - checkout/sidebar/display | +| `minicart_max_items` - [`Int`](#int) | Extended Config Data - checkout/sidebar/count | +| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | +| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | +| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | +| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | +| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | +| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | +| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | +| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | +| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | +| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | +| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | +| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | +| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | +| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | +| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | +| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | +| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `store_group_name` - [`String`](#string) | The label assigned to the store group. | +| `store_name` - [`String`](#string) | The label assigned to the store view. | +| `store_sort_order` - [`Int`](#int) | The store view sort order. | +| `timezone` - [`String`](#string) | The time zone of the store. | +| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | +| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | +| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | +| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](#id) | The unique ID for the website. | +| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `website_name` - [`String`](#string) | The label assigned to the website. | +| `weight_unit` - [`String`](#string) | The unit of weight. | +| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | +| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | +| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | + +#### Example + +```json +{ + "absolute_footer": "xyz789", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "xyz789", + "allow_order": "abc123", + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": true, + "base_currency_code": "xyz789", + "base_link_url": "abc123", + "base_media_url": "abc123", + "base_static_url": "abc123", + "base_url": "abc123", + "braintree_3dsecure_allowspecific": false, + "braintree_3dsecure_always_request_3ds": true, + "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_environment": "abc123", + "braintree_googlepay_btn_color": "xyz789", + "braintree_googlepay_cctypes": "xyz789", + "braintree_googlepay_merchant_id": "abc123", + "braintree_googlepay_vault_active": false, + "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": "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": "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": false, + "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": "abc123", + "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": "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": "abc123", + "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": "xyz789", + "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": "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_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": "abc123", + "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": 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": 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": false, + "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": true, + "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": "xyz789", + "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", + "category_url_suffix": "abc123", + "check_money_order_enable_for_specific_countries": true, + "check_money_order_enabled": true, + "check_money_order_make_check_payable_to": "xyz789", + "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": "abc123", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 123, + "check_money_order_title": "xyz789", + "cms_home_page": "xyz789", + "cms_no_cookies": "xyz789", + "cms_no_route": "xyz789", + "code": "abc123", + "configurable_thumbnail_source": "abc123", + "contact_enabled": false, + "copyright": "xyz789", + "countries_with_required_region": "xyz789", + "create_account_confirmation": false, + "customer_access_token_lifetime": 987.65, + "default_country": "xyz789", + "default_description": "abc123", + "default_display_currency_code": "xyz789", + "default_keywords": "xyz789", + "default_title": "abc123", + "demonotice": 987, + "display_state_if_optional": true, + "enable_multiple_wishlists": "xyz789", + "front": "abc123", + "grid_per_page": 987, + "grid_per_page_values": "xyz789", + "head_includes": "abc123", + "head_shortcut_icon": "abc123", + "header_logo_src": "xyz789", + "id": 987, + "is_default_store": true, + "is_default_store_group": false, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": true, + "is_one_page_checkout_enabled": true, + "is_requisition_list_active": "abc123", + "list_mode": "xyz789", + "list_per_page": 123, + "list_per_page_values": "abc123", + "locale": "abc123", + "logo_alt": "xyz789", + "logo_height": 123, + "logo_width": 987, + "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": "abc123", + "magento_reward_points_invitation_order": "abc123", + "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": "abc123", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": true, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, + "no_route": "abc123", + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": true, + "order_cancellation_reasons": [CancellationReason], + "payment_payflowpro_cc_vault_active": "xyz789", + "printed_card_price": "abc123", + "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", + "product_reviews_enabled": "abc123", + "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": "abc123", + "sales_printed_card": "xyz789", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "xyz789", + "send_friend": SendFriendConfiguration, + "shopping_cart_display_full_summary": false, + "shopping_cart_display_grand_total": false, + "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": true, + "show_cms_breadcrumbs": 123, + "store_code": 4, + "store_group_code": "4", + "store_group_name": "xyz789", + "store_name": "xyz789", + "store_sort_order": 987, + "timezone": "xyz789", + "title_prefix": "xyz789", + "title_separator": "abc123", + "title_suffix": "xyz789", + "use_store_in_url": true, + "website_code": 4, + "website_id": 123, + "website_name": "abc123", + "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": "abc123", + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "xyz789" +} +``` + + + +### StorefrontProperties + +Indicates where an attribute can be displayed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | + +#### Example + +```json +{ + "position": 987, + "use_in_layered_navigation": "NO", + "use_in_product_listing": false, + "use_in_search_results_layered_navigation": false, + "visible_on_catalog_pages": true +} +``` + + + +### String + +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 + +```json +"abc123" +``` + + + +### SubmitNegotiableQuoteTemplateForReviewInput + +Specifies the quote template properties to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String`](#string) | A comment for the seller to review. | +| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | +| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "comment": "xyz789", + "max_order_commitment": 987, + "min_order_commitment": 123, + "name": "xyz789", + "template_id": "4" +} +``` + + + +### SubscribeEmailToNewsletterOutput + +Contains the result of the `subscribeEmailToNewsletter` operation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | + +#### Example + +```json +{"status": "NOT_ACTIVE"} +``` + + + +### SubscriptionStatusesEnum + +Indicates the status of the request. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_ACTIVE` | | +| `SUBSCRIBED` | | +| `UNSUBSCRIBED` | | +| `UNCONFIRMED` | | + +#### Example + +```json +""NOT_ACTIVE"" +``` + + + +### SwatchData + +Describes the swatch type and a value. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | +| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | + +#### Example + +```json +{ + "type": "xyz789", + "value": "xyz789" +} +``` + + + +### SwatchDataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Possible Types + +| SwatchDataInterface Types | +|----------------| +| [`ImageSwatchData`](#imageswatchdata) | +| [`TextSwatchData`](#textswatchdata) | +| [`ColorSwatchData`](#colorswatchdata) | + +#### Example + +```json +{"value": "abc123"} +``` + + + +### SwatchInputTypeEnum + +Swatch attribute metadata input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `DROPDOWN` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `UNDEFINED` | | +| `VISUAL` | | +| `WEIGHT` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### SwatchLayerFilterItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Example + +```json +{ + "items_count": 123, + "label": "abc123", + "swatch_data": SwatchData, + "value_string": "xyz789" +} +``` + + + +### SwatchLayerFilterItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | + +#### Possible Types + +| SwatchLayerFilterItemInterface Types | +|----------------| +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | + +#### Example + +```json +{"swatch_data": SwatchData} +``` + + + +### SyncPaymentOrderInput + +Synchronizes the payment order details + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `id` - [`String!`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cartId": "xyz789", + "id": "abc123" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-t-z.md new file mode 100644 index 000000000..097fb9bfe --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-t-z.md @@ -0,0 +1,1516 @@ +## Types + +### TaxItem + +Contains tax item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | +| `title` - [`String!`](#string) | A title that describes the tax. | + +#### Example + +```json +{ + "amount": Money, + "rate": 123.45, + "title": "xyz789" +} +``` + + + +### TaxWrappingEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `DISPLAY_EXCLUDING_TAX` | | +| `DISPLAY_INCLUDING_TAX` | | +| `DISPLAY_TYPE_BOTH` | | + +#### Example + +```json +""DISPLAY_EXCLUDING_TAX"" +``` + + + +### TextSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### TierPrice + +Defines a price based on the quantity purchased. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](#money) | The price of the product at this tier. | +| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | + +#### Example + +```json +{ + "discount": ProductDiscount, + "final_price": Money, + "quantity": 123.45 +} +``` + + + +### UpdateCartItemsInput + +Modifies the specified items in the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [CartItemUpdateInput] +} +``` + + + +### UpdateCartItemsOutput + +Contains details about the cart after updating items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after updating products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### UpdateCompanyOutput + +Contains the response to the request to update the company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyRoleOutput + +Contains the response to the request to update the company role. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | + +#### Example + +```json +{"role": CompanyRole} +``` + + + +### UpdateCompanyStructureOutput + +Contains the response to the request to update the company structure. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyTeamOutput + +Contains the response to the request to update a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | + +#### Example + +```json +{"team": CompanyTeam} +``` + + + +### UpdateCompanyUserOutput + +Contains the response to the request to update the company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user` - [`Customer!`](#customer) | The updated company user instance. | + +#### Example + +```json +{"user": Customer} +``` + + + +### UpdateGiftRegistryInput + +Defines updates to a `GiftRegistry` object. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](#string) | The updated name of the event. | +| `message` - [`String`](#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "xyz789", + "message": "abc123", + "privacy_settings": "PRIVATE", + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" +} +``` + + + +### UpdateGiftRegistryItemInput + +Defines updates to an item in a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](#string) | The updated description of the item. | +| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | + +#### Example + +```json +{ + "gift_registry_item_uid": "4", + "note": "xyz789", + "quantity": 123.45 +} +``` + + + +### UpdateGiftRegistryItemsOutput + +Contains the results of a request to update gift registry items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryOutput + +Contains the results of a request to update a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryRegistrantInput + +Defines updates to an existing registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | +| `firstname` - [`String`](#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](#string) | The updated last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "abc123", + "gift_registry_registrant_uid": 4, + "lastname": "abc123" +} +``` + + + +### UpdateGiftRegistryRegistrantsOutput + +Contains the results a request to update registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateNegotiableQuoteItemsQuantityOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### UpdateNegotiableQuoteQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteItemQuantityInput], + "quote_uid": 4 +} +``` + + + +### UpdateNegotiableQuoteTemplateItemsQuantityOutput + +Contains the updated negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | + +#### Example + +```json +{"quote_template": NegotiableQuoteTemplate} +``` + + + +### UpdateNegotiableQuoteTemplateQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteTemplateItemQuantityInput], + "template_id": "4" +} +``` + + + +### UpdateProductsInWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### UpdatePurchaseOrderApprovalRuleInput + +Defines the changes to be made to an approval rule. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](#string) | The updated approval rule description. | +| `name` - [`String`](#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | + +#### Example + +```json +{ + "applies_to": ["4"], + "approvers": ["4"], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "abc123", + "name": "abc123", + "status": "ENABLED", + "uid": 4 +} +``` + + + +### UpdateRequisitionListInput + +An input object that defines which requistion list characteristics to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | The updated description of the requisition list. | +| `name` - [`String!`](#string) | The new name of the requisition list. | + +#### Example + +```json +{ + "description": "xyz789", + "name": "xyz789" +} +``` + + + +### UpdateRequisitionListItemsInput + +Defines which items in a requisition list to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "item_id": "4", + "quantity": 987.65, + "selected_options": ["abc123"] +} +``` + + + +### UpdateRequisitionListItemsOutput + +Output of the request to update items in the specified requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateRequisitionListOutput + +Output of the request to rename the requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateWishlistOutput + +Contains the name and visibility of an updated wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](#string) | The wish list name. | +| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "name": "abc123", + "uid": 4, + "visibility": "PUBLIC" +} +``` + + + +### UrlRewrite + +Contains URL rewrite details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](#string) | The request URL. | + +#### Example + +```json +{ + "parameters": [HttpQueryParameter], + "url": "xyz789" +} +``` + + + +### UrlRewriteEntityTypeEnum + +This enumeration defines the entity type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CMS_PAGE` | | +| `PRODUCT` | | +| `CATEGORY` | | + +#### Example + +```json +""CMS_PAGE"" +``` + + + +### UseInLayeredNavigationOptions + +Defines whether the attribute is filterable in layered navigation. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NO` | | +| `FILTERABLE_WITH_RESULTS` | | +| `FILTERABLE_NO_RESULT` | | + +#### Example + +```json +""NO"" +``` + + + +### UserCompaniesInput + +Defines the input for returning matching companies the customer is assigned to. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](#companiessortinput) | Defines the sorting of the results. | + +#### Example + +```json +{ + "currentPage": 987, + "pageSize": 123, + "sort": [CompaniesSortInput] +} +``` + + + +### UserCompaniesOutput + +An object that contains a list of companies customer is assigned to. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | + +#### Example + +```json +{ + "items": [CompanyBasicInfo], + "page_info": SearchResultPageInfo +} +``` + + + +### ValidatePurchaseOrderError + +Contains details about a failed validation attempt. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | + +#### Example + +```json +{"message": "xyz789", "type": "NOT_FOUND"} +``` + + + +### ValidatePurchaseOrderErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | + +#### Example + +```json +""NOT_FOUND"" +``` + + + +### ValidatePurchaseOrdersInput + +Defines the purchase orders to be validated. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | + +#### Example + +```json +{"purchase_order_uids": [4]} +``` + + + +### ValidatePurchaseOrdersOutput + +Contains the results of validation attempts. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | + +#### Example + +```json +{ + "errors": [ValidatePurchaseOrderError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### ValidationRule + +Defines a customer attribute validation rule. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | +| `value` - [`String`](#string) | Validation rule value. | + +#### Example + +```json +{ + "name": "DATE_RANGE_MAX", + "value": "abc123" +} +``` + + + +### ValidationRuleEnum + +List of validation rule names applied to a customer attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""DATE_RANGE_MAX"" +``` + + + +### VaultMethodInput + +Vault payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| `public_hash` - [`String`](#string) | The public hash of the token. | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123", + "public_hash": "xyz789" +} +``` + + + +### VaultTokenInput + +Contains required input for payment methods with Vault support. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `public_hash` - [`String!`](#string) | The public hash of the payment token. | + +#### Example + +```json +{"public_hash": "abc123"} +``` + + + +### VirtualCartItem + +An implementation for virtual product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "id": "xyz789", + "is_available": true, + "max_qty": 123.45, + "min_qty": 123.45, + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### VirtualProduct + +Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`String`](#string) | Indicates whether a gift message is available. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": "xyz789", + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "xyz789", + "staged": false, + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "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": "abc123", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website] +} +``` + + + +### VirtualProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### VirtualRequisitionListItem + +Contains details about virtual products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### VirtualWishlistItem + +Contains a virtual product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### Website + +Deprecated. It should not be used on the storefront. Contains information about a website. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | +| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "code": "xyz789", + "default_group_id": "xyz789", + "id": 987, + "is_default": true, + "name": "xyz789", + "sort_order": 987 +} +``` + + + +### WishListUserInputError + +An error encountered while performing operations with WishList. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" +} +``` + + + +### WishListUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### Wishlist + +Contains a customer wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. | +| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | +| `name` - [`String`](#string) | The name of the wish list. | +| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "id": "4", + "items": [WishlistItem], + "items_count": 123, + "items_v2": WishlistItems, + "name": "xyz789", + "sharing_code": "xyz789", + "updated_at": "abc123", + "visibility": "PUBLIC" +} +``` + + + +### WishlistCartUserInputError + +Contains details about errors encountered when a customer added wish list items to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | +| `message` - [`String!`](#string) | A localized error message. | +| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123", + "wishlistId": 4, + "wishlistItemId": 4 +} +``` + + + +### WishlistCartUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### WishlistItem + +Contains details about a wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](#string) | The customer's comment about this item. | +| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](#float) | The quantity of this wish list item | + +#### Example + +```json +{ + "added_at": "abc123", + "description": "xyz789", + "id": 123, + "product": ProductInterface, + "qty": 123.45 +} +``` + + + +### WishlistItemCopyInput + +Specifies the IDs of items to copy and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | + +#### Example + +```json +{"quantity": 123.45, "wishlist_item_id": 4} +``` + + + +### WishlistItemInput + +Defines the items to add to a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": ["4"], + "sku": "xyz789" +} +``` + + + +### WishlistItemInterface + +The interface for wish list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Possible Types + +| WishlistItemInterface Types | +|----------------| +| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`VirtualWishlistItem`](#virtualwishlistitem) | +| [`ConfigurableWishlistItem`](#configurablewishlistitem) | +| [`DownloadableWishlistItem`](#downloadablewishlistitem) | +| [`BundleWishlistItem`](#bundlewishlistitem) | +| [`GiftCardWishlistItem`](#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": 4, + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### WishlistItemMoveInput + +Specifies the IDs of the items to move and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | + +#### Example + +```json +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} +``` + + + +### WishlistItemUpdateInput + +Defines updates to items in a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | + +#### Example + +```json +{ + "description": "abc123", + "entered_options": [EnteredOptionInput], + "quantity": 123.45, + "selected_options": [4], + "wishlist_item_id": "4" +} +``` + + + +### WishlistItems + +Contains an array of items in a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | + +#### Example + +```json +{ + "items": [WishlistItemInterface], + "page_info": SearchResultPageInfo +} +``` + + + +### WishlistOutput + +Deprecated: Use the `Wishlist` type instead. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | +| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | + +#### Example + +```json +{ + "items": [WishlistItem], + "items_count": 987, + "name": "xyz789", + "sharing_code": "xyz789", + "updated_at": "xyz789" +} +``` + + + +### WishlistVisibilityEnum + +Defines the wish list visibility types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PUBLIC` | | +| `PRIVATE` | | + +#### Example + +```json +""PUBLIC"" +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-mutations.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-mutations.md index bd43fbd2f..65eea2da2 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-mutations.md @@ -110,11 +110,11 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "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, @@ -126,7 +126,7 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu ], "status": "xyz789", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -358,7 +358,7 @@ mutation addProductsToCart( ```json { - "cartId": "abc123", + "cartId": "xyz789", "cartItems": [CartItemInput] } ``` @@ -422,9 +422,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -681,10 +681,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": ["4"] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -697,7 +694,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } } } @@ -927,7 +924,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": true, + "status": false, "wishlist": Wishlist } } @@ -1335,14 +1332,14 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "billing_address": BillingCartAddress, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, - "is_virtual": false, + "id": "4", + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1424,14 +1421,14 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1440,7 +1437,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, "total_quantity": 123.45 } @@ -1492,7 +1489,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1562,8 +1559,8 @@ Change the password for the logged-in customer. | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](#string) | The customer's original password. | +| `newPassword` - [`String!`](#string) | The customer's updated password. | #### Example @@ -1700,15 +1697,15 @@ mutation changeCustomerPassword( "changeCustomerPassword": { "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_shipping": "xyz789", + "default_billing": "xyz789", + "default_shipping": "abc123", "dob": "abc123", "email": "abc123", "firstname": "xyz789", @@ -1717,13 +1714,13 @@ mutation changeCustomerPassword( "gift_registry": GiftRegistry, "group": CustomerGroup, "group_id": 123, - "id": 987, - "is_subscribed": true, + "id": 123, + "is_subscribed": false, "job_title": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -1739,11 +1736,11 @@ mutation changeCustomerPassword( "segments": [CustomerSegment], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1834,7 +1831,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "xyz789"} +{"cartUid": "abc123"} ``` ##### Response @@ -1842,7 +1839,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": false} + "clearCustomerCart": {"cart": Cart, "status": true} } } ``` @@ -2087,7 +2084,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": false}}} +{"data": {"contactUs": {"status": true}}} ``` @@ -2133,7 +2130,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2638,26 +2635,26 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { { "data": { "createCustomerAddress": { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", - "country_id": "abc123", + "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, "default_billing": true, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", - "id": 987, - "lastname": "xyz789", + "id": 123, + "lastname": "abc123", "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "abc123", "vat_id": "xyz789" @@ -2872,11 +2869,11 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { { "data": { "createPayflowProToken": { - "response_message": "xyz789", + "response_message": "abc123", "result": 987, - "result_code": 123, - "secure_token": "abc123", - "secure_token_id": "xyz789" + "result_code": 987, + "secure_token": "xyz789", + "secure_token_id": "abc123" } } } @@ -2925,7 +2922,7 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { "data": { "createPaymentOrder": { "amount": 123.45, - "currency_code": "xyz789", + "currency_code": "abc123", "id": "abc123", "mp_order_id": "xyz789", "status": "xyz789" @@ -3082,7 +3079,7 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", + "created_at": "xyz789", "created_by": "abc123", "description": "abc123", "name": "abc123", @@ -3182,7 +3179,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } } } @@ -3301,7 +3298,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3381,7 +3378,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3517,13 +3514,13 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response ```json -{"data": {"deleteCustomerAddress": false}} +{"data": {"deleteCustomerAddress": true}} ``` @@ -3559,7 +3556,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": false}} +{"data": {"deleteNegotiableQuoteTemplate": true}} ``` @@ -3653,7 +3650,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -3802,8 +3799,8 @@ mutation deleteRequisitionListItems( ```json { - "requisitionListUid": 4, - "requisitionListItemUids": ["4"] + "requisitionListUid": "4", + "requisitionListItemUids": [4] } ``` @@ -3851,7 +3848,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -3860,7 +3857,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": true, + "status": false, "wishlists": [Wishlist] } } @@ -3968,11 +3965,11 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "estimateShippingMethods": [ { "amount": Money, - "available": false, + "available": true, "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "abc123", - "error_message": "xyz789", + "carrier_code": "xyz789", + "carrier_title": "xyz789", + "error_message": "abc123", "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, @@ -4035,8 +4032,8 @@ Generate a token for specified customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -4060,7 +4057,7 @@ mutation generateCustomerToken( ```json { - "email": "xyz789", + "email": "abc123", "password": "abc123" } ``` @@ -4217,7 +4214,7 @@ Transfer the contents of a guest cart into the cart of a logged-in customer. | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | +| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | | `destination_cart_id` - [`String`](#string) | The cart ID after the guest logs in. | #### Example @@ -4316,16 +4313,16 @@ mutation mergeCarts( AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": true, + "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], @@ -4377,7 +4374,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": 4, "giftRegistryUid": "4"} +{"cartUid": "4", "giftRegistryUid": 4} ``` ##### Response @@ -4387,7 +4384,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } } @@ -4439,7 +4436,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", + "sourceRequisitionListUid": 4, "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } @@ -4646,10 +4643,10 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "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": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -4660,7 +4657,7 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", "total_quantity": 987.65 } @@ -4720,7 +4717,7 @@ Convert the quote into an order. | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -4896,7 +4893,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, "code": "xyz789", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -5101,7 +5098,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -5148,10 +5145,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{ - "giftRegistryUid": "4", - "itemsUid": ["4"] -} +{"giftRegistryUid": 4, "itemsUid": [4]} ``` ##### Response @@ -5204,10 +5198,7 @@ mutation removeGiftRegistryRegistrants( ##### Variables ```json -{ - "giftRegistryUid": "4", - "registrantsUid": ["4"] -} +{"giftRegistryUid": 4, "registrantsUid": [4]} ``` ##### Response @@ -5382,11 +5373,11 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "comments": [NegotiableQuoteComment], "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5398,7 +5389,7 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat ], "status": "xyz789", "template_id": "4", - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -5450,7 +5441,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": 4 } @@ -5948,10 +5939,10 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5961,9 +5952,9 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -5981,7 +5972,7 @@ Request an email with a reset password token for the registered customer identif | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](#string) | The customer's email address. | #### Example @@ -6082,7 +6073,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -6103,9 +6094,9 @@ Reset a customer's password using the reset password token that the customer rec | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](#string) | The customer's new password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](#string) | The customer's new password. | #### Example @@ -6129,8 +6120,8 @@ mutation resetPassword( ```json { - "email": "abc123", - "resetPasswordToken": "xyz789", + "email": "xyz789", + "resetPasswordToken": "abc123", "newPassword": "xyz789" } ``` @@ -6681,12 +6672,12 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6873,13 +6864,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "setQuoteTemplateLineItemNote": { "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, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -6889,7 +6880,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", "total_quantity": 123.45 } @@ -6990,7 +6981,7 @@ Send an email about the gift registry to a list of invitees. | Name | Description | |------|-------------| | `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | | `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7017,7 +7008,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7026,7 +7017,7 @@ mutation shareGiftRegistry( ##### Response ```json -{"data": {"shareGiftRegistry": {"is_shared": true}}} +{"data": {"shareGiftRegistry": {"is_shared": false}}} ``` @@ -7101,14 +7092,14 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "submitNegotiableQuoteTemplateForReview": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, - "name": "abc123", + "max_order_commitment": 123, + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -7118,8 +7109,8 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, - "total_quantity": 987.65 + "template_id": "4", + "total_quantity": 123.45 } } } @@ -7137,7 +7128,7 @@ Subscribe the specified email to the store's newsletter. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | #### Example @@ -7154,7 +7145,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -7196,7 +7187,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": true}} +{"data": {"syncPaymentOrder": false}} ``` @@ -7211,7 +7202,7 @@ Track that a product was viewed in adobe commerce | Name | Description | |------|-------------| -| `sku` - [`String!`](#string) | The sku for a `ProductInterface` object. | +| `sku` - [`String!`](#string) | The sku for a `ProductInterface` object. | #### Example @@ -7232,7 +7223,7 @@ mutation trackViewedProduct($sku: String!) { ##### Response ```json -{"data": {"trackViewedProduct": true}} +{"data": {"trackViewedProduct": false}} ``` @@ -7593,7 +7584,7 @@ mutation updateCustomerAddress( ##### Variables ```json -{"id": 987, "input": CustomerAddressInput} +{"id": 123, "input": CustomerAddressInput} ``` ##### Response @@ -7602,28 +7593,28 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, - "default_billing": false, + "customer_id": 123, + "default_billing": true, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "xyz789", + "fax": "xyz789", + "firstname": "abc123", "id": 987, - "lastname": "xyz789", - "middlename": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", + "suffix": "abc123", + "telephone": "abc123", "vat_id": "abc123" } } @@ -7642,8 +7633,8 @@ Change the email address for the logged-in customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -7669,8 +7660,8 @@ mutation updateCustomerEmail( ```json { - "email": "xyz789", - "password": "xyz789" + "email": "abc123", + "password": "abc123" } ``` @@ -7869,7 +7860,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -8094,13 +8085,13 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "abc123", - "description": "xyz789", - "name": "xyz789", + "created_at": "abc123", + "created_by": "xyz789", + "description": "abc123", + "name": "abc123", "status": "ENABLED", - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -8274,7 +8265,7 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "xyz789", + "name": "abc123", "uid": "4", "visibility": "PUBLIC" } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-queries.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-queries.md index 06e9e2f25..45a6afc8c 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-queries.md @@ -411,38 +411,38 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "absolute_footer": "xyz789", + "absolute_footer": "abc123", "allow_gift_receipt": "abc123", "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "xyz789", + "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "abc123", - "allow_order": "abc123", - "allow_printed_card": "xyz789", + "allow_items": "xyz789", + "allow_order": "xyz789", + "allow_printed_card": "abc123", "autocomplete_on_storefront": false, "base_currency_code": "abc123", - "base_link_url": "xyz789", + "base_link_url": "abc123", "base_media_url": "xyz789", - "base_static_url": "abc123", + "base_static_url": "xyz789", "base_url": "xyz789", "braintree_3dsecure_allowspecific": true, - "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_always_request_3ds": false, "braintree_3dsecure_specificcountry": "abc123", - "braintree_3dsecure_threshold_amount": "abc123", + "braintree_3dsecure_threshold_amount": "xyz789", "braintree_3dsecure_verify_3dsecure": true, - "braintree_ach_direct_debit_vault_active": false, - "braintree_applepay_merchant_name": "xyz789", + "braintree_ach_direct_debit_vault_active": true, + "braintree_applepay_merchant_name": "abc123", "braintree_applepay_vault_active": true, - "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": true, + "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_cvv": false, "braintree_environment": "abc123", - "braintree_googlepay_btn_color": "abc123", + "braintree_googlepay_btn_color": "xyz789", "braintree_googlepay_cctypes": "abc123", "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": true, + "braintree_googlepay_vault_active": false, "braintree_local_payment_allowed_methods": "abc123", - "braintree_local_payment_fallback_button_text": "abc123", - "braintree_local_payment_redirect_on_fail": "abc123", + "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", @@ -451,61 +451,61 @@ query availableStores($useCurrentGroup: Boolean) { "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": 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_messaging_show": true, + "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": "xyz789", - "braintree_paypal_button_location_cart_type_paylater_shape": "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": "abc123", "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": true, + "braintree_paypal_button_location_cart_type_paypal_shape": "xyz789", + "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": "xyz789", "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": "abc123", + "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": "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_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": "xyz789", - "braintree_paypal_button_location_checkout_type_paylater_show": false, + "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": "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_color": "xyz789", + "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", "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": "abc123", - "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_layout": "abc123", + "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": 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_paypal_color": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_label": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789", + "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": "abc123", - "braintree_paypal_display_on_shopping_cart": true, + "braintree_paypal_display_on_shopping_cart": false, "braintree_paypal_merchant_country": "abc123", "braintree_paypal_merchant_name_override": "xyz789", - "braintree_paypal_require_billing_address": false, - "braintree_paypal_send_cart_line_items": false, + "braintree_paypal_require_billing_address": true, + "braintree_paypal_send_cart_line_items": true, "braintree_paypal_vault_active": true, "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 987, + "cart_gift_wrapping": "abc123", + "cart_printed_card": "abc123", + "cart_summary_display_quantity": 123, "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "abc123", @@ -513,102 +513,102 @@ query availableStores($useCurrentGroup: Boolean) { "check_money_order_enabled": true, "check_money_order_make_check_payable_to": "xyz789", "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_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_sort_order": 123, "check_money_order_title": "xyz789", "cms_home_page": "abc123", - "cms_no_cookies": "abc123", + "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", "code": "abc123", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, + "configurable_thumbnail_source": "abc123", + "contact_enabled": false, "copyright": "xyz789", - "countries_with_required_region": "xyz789", - "create_account_confirmation": false, + "countries_with_required_region": "abc123", + "create_account_confirmation": true, "customer_access_token_lifetime": 123.45, - "default_country": "abc123", + "default_country": "xyz789", "default_description": "abc123", "default_display_currency_code": "abc123", - "default_keywords": "abc123", - "default_title": "abc123", + "default_keywords": "xyz789", + "default_title": "xyz789", "demonotice": 987, "display_product_prices_in_catalog": 987, - "display_shipping_prices": 123, + "display_shipping_prices": 987, "display_state_if_optional": true, - "enable_multiple_wishlists": "abc123", + "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 987, + "fixed_product_taxes_display_prices_in_emails": 123, "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": 123, - "fixed_product_taxes_enable": true, + "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": true, "front": "abc123", "graphql_share_all_customer_groups": false, - "graphql_share_customer_group": false, + "graphql_share_customer_group": true, "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, - "is_checkout_agreements_enabled": true, + "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": "abc123", - "list_mode": "xyz789", + "is_negotiable_quote_active": true, + "is_one_page_checkout_enabled": false, + "is_requisition_list_active": "xyz789", + "list_mode": "abc123", "list_per_page": 987, "list_per_page_values": "abc123", "locale": "xyz789", - "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": "abc123", + "magento_reward_general_is_enabled_on_front": "xyz789", + "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_publish_history": "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": "abc123", - "magento_reward_points_newsletter": "xyz789", + "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_order_limit": "xyz789", + "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "xyz789", "magento_reward_points_register": "xyz789", "magento_reward_points_review": "abc123", - "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": false, + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": true, "minicart_max_items": 987, "minimum_password_length": "abc123", "newsletter_enabled": true, - "no_route": "xyz789", - "optional_zip_countries": "xyz789", + "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": false, - "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_full_summary": true, + "orders_invoices_credit_memos_display_grandtotal": true, + "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": "abc123", - "printed_card_price": "xyz789", + "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": "xyz789", + "product_url_suffix": "abc123", "quickorder_active": false, "required_character_classes_number": "abc123", "returns_enabled": "xyz789", @@ -622,9 +622,9 @@ query availableStores($useCurrentGroup: Boolean) { "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "share_all_catalog_rules": true, + "share_all_catalog_rules": false, "share_all_sales_rule": true, - "share_applied_catalog_rules": true, + "share_applied_catalog_rules": false, "share_applied_sales_rule": false, "shopping_cart_display_full_summary": false, "shopping_cart_display_grand_total": false, @@ -632,28 +632,28 @@ query availableStores($useCurrentGroup: Boolean) { "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, + "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 123, - "store_code": 4, + "store_code": "4", "store_group_code": "4", "store_group_name": "xyz789", - "store_name": "abc123", + "store_name": "xyz789", "store_sort_order": 987, - "timezone": "abc123", + "timezone": "xyz789", "title_prefix": "xyz789", - "title_separator": "abc123", + "title_separator": "xyz789", "title_suffix": "abc123", - "use_store_in_url": false, + "use_store_in_url": true, "website_code": "4", "website_id": 987, - "website_name": "abc123", + "website_name": "xyz789", "weight_unit": "xyz789", - "welcome": "abc123", + "welcome": "xyz789", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, "zero_subtotal_title": "xyz789" } @@ -763,11 +763,11 @@ query cart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, @@ -776,7 +776,7 @@ query cart($cart_id: String!) { "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -935,42 +935,42 @@ query category($id: Int) { "data": { "category": { "automatic_sorting": "xyz789", - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "abc123", "children": [CategoryTree], - "children_count": "xyz789", + "children_count": "abc123", "cms_block": CmsBlock, "created_at": "abc123", - "custom_layout_update_file": "xyz789", + "custom_layout_update_file": "abc123", "default_sort_by": "abc123", - "description": "abc123", + "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 123.45, "id": 987, - "image": "abc123", + "image": "xyz789", "include_in_menu": 987, - "is_anchor": 987, + "is_anchor": 123, "landing_page": 987, - "level": 987, + "level": 123, "meta_description": "abc123", "meta_keywords": "abc123", - "meta_title": "xyz789", + "meta_title": "abc123", "name": "abc123", - "path": "xyz789", + "path": "abc123", "path_in_store": "xyz789", - "position": 987, + "position": 123, "product_count": 987, "products": CategoryProducts, - "redirect_code": 123, - "relative_url": "xyz789", + "redirect_code": 987, + "relative_url": "abc123", "staged": false, "type": "CMS_PAGE", - "uid": "4", - "updated_at": "abc123", + "uid": 4, + "updated_at": "xyz789", "url_key": "xyz789", - "url_path": "xyz789", - "url_suffix": "xyz789" + "url_path": "abc123", + "url_suffix": "abc123" } } } @@ -1077,43 +1077,43 @@ query categoryList( "data": { "categoryList": [ { - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], + "automatic_sorting": "xyz789", + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], "children_count": "abc123", "cms_block": CmsBlock, - "created_at": "xyz789", + "created_at": "abc123", "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", + "default_sort_by": "xyz789", "description": "xyz789", - "display_mode": "xyz789", + "display_mode": "abc123", "filter_price_range": 123.45, - "id": 123, + "id": 987, "image": "xyz789", "include_in_menu": 987, "is_anchor": 987, - "landing_page": 987, + "landing_page": 123, "level": 123, "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "abc123", - "name": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", + "name": "xyz789", "path": "xyz789", - "path_in_store": "xyz789", - "position": 987, + "path_in_store": "abc123", + "position": 123, "product_count": 123, "products": CategoryProducts, - "redirect_code": 123, + "redirect_code": 987, "relative_url": "abc123", "staged": false, "type": "CMS_PAGE", - "uid": 4, - "updated_at": "xyz789", + "uid": "4", + "updated_at": "abc123", "url_key": "xyz789", - "url_path": "abc123", - "url_suffix": "xyz789" + "url_path": "xyz789", + "url_suffix": "abc123" } ] } @@ -1153,8 +1153,8 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 123, - "checkbox_text": "abc123", + "agreement_id": 987, + "checkbox_text": "xyz789", "content": "abc123", "content_height": "xyz789", "is_html": true, @@ -1197,7 +1197,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["abc123"]} +{"identifiers": ["xyz789"]} ``` ##### Response @@ -1253,7 +1253,7 @@ query cmsPage( ##### Variables ```json -{"id": 987, "identifier": "xyz789"} +{"id": 123, "identifier": "xyz789"} ``` ##### Response @@ -1262,18 +1262,18 @@ query cmsPage( { "data": { "cmsPage": { - "content": "xyz789", + "content": "abc123", "content_heading": "abc123", - "identifier": "abc123", + "identifier": "xyz789", "meta_description": "xyz789", - "meta_keywords": "abc123", + "meta_keywords": "xyz789", "meta_title": "abc123", - "page_layout": "abc123", + "page_layout": "xyz789", "redirect_code": 123, "relative_url": "abc123", "title": "abc123", "type": "CMS_PAGE", - "url_key": "xyz789" + "url_key": "abc123" } } } @@ -1354,8 +1354,8 @@ query company { "email": "xyz789", "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "abc123", - "name": "xyz789", + "legal_name": "xyz789", + "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "xyz789", "role": CompanyRole, @@ -1365,7 +1365,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -1507,7 +1507,7 @@ query country($id: String) { ##### Variables ```json -{"id": "xyz789"} +{"id": "abc123"} ``` ##### Response @@ -1518,10 +1518,10 @@ query country($id: String) { "country": { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "abc123", + "full_name_locale": "xyz789", "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "xyz789" } } } @@ -1563,13 +1563,13 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "abc123", - "base_currency_symbol": "xyz789", + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", "default_display_currecy_code": "xyz789", "default_display_currecy_symbol": "abc123", - "default_display_currency_code": "xyz789", + "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -1803,30 +1803,30 @@ query customer { "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": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "abc123", - "default_billing": "abc123", + "date_of_birth": "xyz789", + "default_billing": "xyz789", "default_shipping": "xyz789", "dob": "abc123", - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroup, "group_id": 123, - "id": 987, + "id": 123, "is_subscribed": true, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "abc123", "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "abc123", + "prefix": "xyz789", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -1843,10 +1843,10 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": 4, - "suffix": "xyz789", + "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1944,16 +1944,16 @@ query customerCart { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRule], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -2032,7 +2032,7 @@ query customerOrders { { "data": { "customerOrders": { - "date_of_first_order": "abc123", + "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, "total_count": 987 @@ -2133,7 +2133,7 @@ query dynamicBlocks( "dynamicBlocks": { "items": [DynamicBlock], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -2226,8 +2226,8 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "getPayflowLinkToken": { "mode": "TEST", "paypal_url": "abc123", - "secure_token": "xyz789", - "secure_token_id": "abc123" + "secure_token": "abc123", + "secure_token_id": "xyz789" } } } @@ -2333,7 +2333,7 @@ query getPaymentOrder( ```json { - "cartId": "xyz789", + "cartId": "abc123", "id": "abc123" } ``` @@ -2345,9 +2345,9 @@ query getPaymentOrder( "data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -2474,8 +2474,8 @@ query giftCardAccount($input: GiftCardAccountInput!) { "data": { "giftCardAccount": { "balance": Money, - "code": "xyz789", - "expiration_date": "abc123" + "code": "abc123", + "expiration_date": "xyz789" } } } @@ -2540,11 +2540,11 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "abc123", "owner_name": "xyz789", @@ -2571,7 +2571,7 @@ Search for gift registries by specifying a registrant email address. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](#string) | The registrant's email. | #### Example @@ -2593,7 +2593,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2603,11 +2603,11 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "abc123", - "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "abc123", - "name": "xyz789", + "event_date": "xyz789", + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "xyz789", + "name": "abc123", "type": "abc123" } ] @@ -2649,7 +2649,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2659,11 +2659,11 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "abc123", "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", + "location": "xyz789", + "name": "abc123", "type": "xyz789" } ] @@ -2716,7 +2716,7 @@ query giftRegistryTypeSearch( ```json { - "firstName": "xyz789", + "firstName": "abc123", "lastName": "xyz789", "giftRegistryTypeUid": "4" } @@ -2730,11 +2730,11 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "abc123", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": "4", "location": "abc123", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ] } @@ -2775,8 +2775,8 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", - "uid": 4 + "label": "xyz789", + "uid": "4" } ] } @@ -2889,17 +2889,17 @@ query guestOrder($input: OrderInformationInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "abc123", + "created_at": "xyz789", "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", + "id": 4, "increment_id": "abc123", "invoices": [Invoice], "is_virtual": true, @@ -2907,7 +2907,7 @@ query guestOrder($input: OrderInformationInput!) { "items_eligible_for_return": [OrderItemInterface], "number": "abc123", "order_date": "xyz789", - "order_number": "xyz789", + "order_number": "abc123", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, @@ -2916,7 +2916,7 @@ query guestOrder($input: OrderInformationInput!) { "shipping_address": OrderAddress, "shipping_method": "xyz789", "status": "xyz789", - "token": "xyz789", + "token": "abc123", "total": OrderTotal } } @@ -3029,33 +3029,33 @@ query guestOrderByToken($input: OrderTokenInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], - "created_at": "xyz789", + "created_at": "abc123", "credit_memos": [CreditMemo], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "grand_total": 123.45, - "id": "4", - "increment_id": "xyz789", + "id": 4, + "increment_id": "abc123", "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", + "number": "xyz789", "order_date": "abc123", "order_number": "abc123", - "order_status_change_date": "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": "abc123", - "status": "abc123", + "shipping_method": "xyz789", + "status": "xyz789", "token": "abc123", "total": OrderTotal } @@ -3130,13 +3130,13 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} ``` @@ -3168,13 +3168,13 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} ``` @@ -3244,7 +3244,7 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -3336,15 +3336,15 @@ query negotiableQuote($uid: ID!) { "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "prices": CartPrices, "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "total_quantity": 123.45, - "uid": "4", + "total_quantity": 987.65, + "uid": 4, "updated_at": "xyz789" } } @@ -3425,12 +3425,12 @@ query negotiableQuoteTemplate($templateId: ID!) { "comments": [NegotiableQuoteComment], "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "abc123", + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -3771,7 +3771,7 @@ query products( ```json { - "search": "xyz789", + "search": "abc123", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3837,7 +3837,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } } } @@ -3877,11 +3877,11 @@ query recaptchaV3Config { "data": { "recaptchaV3Config": { "badge_position": "abc123", - "failure_message": "abc123", + "failure_message": "xyz789", "forms": ["PLACE_ORDER"], "is_enabled": true, "language_code": "xyz789", - "minimum_score": 123.45, + "minimum_score": 987.65, "theme": "xyz789", "website_key": "abc123" } @@ -3901,7 +3901,7 @@ Return the full details for a specified product, category, or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3929,8 +3929,8 @@ query route($url: String!) { { "data": { "route": { - "redirect_code": 987, - "relative_url": "xyz789", + "redirect_code": 123, + "relative_url": "abc123", "type": "CMS_PAGE" } } @@ -4211,249 +4211,249 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "abc123", - "allow_gift_receipt": "xyz789", + "absolute_footer": "xyz789", + "allow_gift_receipt": "abc123", "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", + "allow_guests_to_write_product_reviews": "abc123", + "allow_items": "abc123", "allow_order": "abc123", - "allow_printed_card": "xyz789", - "autocomplete_on_storefront": false, - "base_currency_code": "abc123", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": true, + "base_currency_code": "xyz789", "base_link_url": "abc123", "base_media_url": "abc123", - "base_static_url": "abc123", + "base_static_url": "xyz789", "base_url": "xyz789", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": true, - "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "abc123", - "braintree_3dsecure_verify_3dsecure": true, - "braintree_ach_direct_debit_vault_active": true, + "braintree_3dsecure_verify_3dsecure": false, + "braintree_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "xyz789", - "braintree_applepay_vault_active": false, - "braintree_cc_vault_active": "abc123", + "braintree_applepay_vault_active": true, + "braintree_cc_vault_active": "xyz789", "braintree_cc_vault_cvv": true, "braintree_environment": "xyz789", - "braintree_googlepay_btn_color": "abc123", - "braintree_googlepay_cctypes": "xyz789", + "braintree_googlepay_btn_color": "xyz789", + "braintree_googlepay_cctypes": "abc123", "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "abc123", - "braintree_local_payment_fallback_button_text": "xyz789", - "braintree_local_payment_redirect_on_fail": "xyz789", - "braintree_merchant_account_id": "xyz789", + "braintree_googlepay_vault_active": false, + "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": "abc123", - "braintree_paypal_button_location_cart_type_credit_label": "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_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_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": "abc123", + "braintree_paypal_button_location_cart_type_paylater_color": "xyz789", "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": "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": "xyz789", - "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": "abc123", - "braintree_paypal_button_location_checkout_type_credit_show": true, - "braintree_paypal_button_location_checkout_type_messaging_layout": "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": "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": false, "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": "xyz789", + "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": false, + "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": "abc123", - "braintree_paypal_button_location_productpage_type_credit_label": "abc123", + "braintree_paypal_button_location_productpage_type_credit_label": "xyz789", "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": "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": "abc123", - "braintree_paypal_button_location_productpage_type_messaging_show": true, + "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": "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": "xyz789", + "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": true, + "braintree_paypal_button_location_productpage_type_paypal_color": "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": false, - "braintree_paypal_credit_uk_merchant_name": "abc123", + "braintree_paypal_button_location_productpage_type_paypal_show": true, + "braintree_paypal_credit_uk_merchant_name": "xyz789", "braintree_paypal_display_on_shopping_cart": false, - "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "xyz789", + "braintree_paypal_merchant_country": "xyz789", + "braintree_paypal_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": false, - "braintree_paypal_send_cart_line_items": 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_summary_display_quantity": 123, - "catalog_default_sort_by": "abc123", + "cart_summary_display_quantity": 987, + "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": true, - "check_money_order_make_check_payable_to": "xyz789", + "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": "xyz789", "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "abc123", + "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 123, - "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", + "check_money_order_title": "abc123", + "cms_home_page": "abc123", "cms_no_cookies": "xyz789", - "cms_no_route": "abc123", + "cms_no_route": "xyz789", "code": "xyz789", "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, + "configurable_thumbnail_source": "abc123", + "contact_enabled": false, "copyright": "xyz789", "countries_with_required_region": "xyz789", - "create_account_confirmation": true, - "customer_access_token_lifetime": 987.65, - "default_country": "abc123", + "create_account_confirmation": false, + "customer_access_token_lifetime": 123.45, + "default_country": "xyz789", "default_description": "xyz789", "default_display_currency_code": "abc123", - "default_keywords": "abc123", + "default_keywords": "xyz789", "default_title": "abc123", - "demonotice": 123, + "demonotice": 987, "display_product_prices_in_catalog": 123, - "display_shipping_prices": 123, - "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", + "display_shipping_prices": 987, + "display_state_if_optional": true, + "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_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_display_prices_on_product_view_page": 987, "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": false, - "front": "abc123", + "fixed_product_taxes_include_fpt_in_subtotal": true, + "front": "xyz789", "graphql_share_all_customer_groups": false, - "graphql_share_customer_group": false, - "grid_per_page": 123, + "graphql_share_customer_group": true, + "grid_per_page": 987, "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "head_includes": "abc123", - "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", - "id": 987, + "head_includes": "xyz789", + "head_shortcut_icon": "abc123", + "header_logo_src": "abc123", + "id": 123, "is_checkout_agreements_enabled": false, - "is_default_store": true, - "is_default_store_group": false, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": true, + "is_default_store": false, + "is_default_store_group": true, + "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_mode": "abc123", "list_per_page": 123, - "list_per_page_values": "abc123", - "locale": "abc123", + "list_per_page_values": "xyz789", + "locale": "xyz789", "logo_alt": "xyz789", - "logo_height": 123, - "logo_width": 987, + "logo_height": 987, + "logo_width": 123, "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "abc123", + "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": "abc123", + "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "xyz789", - "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "xyz789", + "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_review": "abc123", - "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 987, - "maximum_number_of_wishlists": "xyz789", - "minicart_display": true, - "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": true, + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", + "newsletter_enabled": false, "no_route": "abc123", - "optional_zip_countries": "xyz789", - "order_cancellation_enabled": true, + "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": 123, + "orders_invoices_credit_memos_display_full_summary": true, + "orders_invoices_credit_memos_display_grandtotal": true, + "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, + "orders_invoices_credit_memos_display_zero_tax": false, "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": "abc123", "product_url_suffix": "xyz789", - "quickorder_active": false, + "quickorder_active": true, "required_character_classes_number": "xyz789", - "returns_enabled": "abc123", + "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": "xyz789", "secure_base_link_url": "xyz789", - "secure_base_media_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "xyz789", - "secure_base_url": "xyz789", + "secure_base_url": "abc123", "send_friend": SendFriendConfiguration, - "share_all_catalog_rules": false, - "share_all_sales_rule": true, - "share_applied_catalog_rules": true, + "share_all_catalog_rules": true, + "share_all_sales_rule": false, + "share_applied_catalog_rules": false, "share_applied_sales_rule": true, - "shopping_cart_display_full_summary": false, + "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, - "shopping_cart_display_subtotal": 123, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": false, "show_cms_breadcrumbs": 987, "store_code": 4, - "store_group_code": "4", + "store_group_code": 4, "store_group_name": "abc123", - "store_name": "xyz789", - "store_sort_order": 123, + "store_name": "abc123", + "store_sort_order": 987, "timezone": "xyz789", - "title_prefix": "xyz789", - "title_separator": "xyz789", - "title_suffix": "xyz789", + "title_prefix": "abc123", + "title_separator": "abc123", + "title_suffix": "abc123", "use_store_in_url": true, - "website_code": "4", - "website_id": 123, + "website_code": 4, + "website_id": 987, "website_name": "xyz789", - "weight_unit": "abc123", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, + "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" + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "xyz789" } } } @@ -4475,7 +4475,7 @@ Return the relative URL for a specified product, category or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4506,10 +4506,10 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "xyz789", + "canonical_url": "abc123", "entity_uid": 4, "id": 987, - "redirectCode": 987, + "redirectCode": 123, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -4554,10 +4554,10 @@ query wishlist { "data": { "wishlist": { "items": [WishlistItem], - "items_count": 987, - "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "abc123" + "items_count": 123, + "name": "xyz789", + "sharing_code": "abc123", + "updated_at": "xyz789" } } } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-2.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-2.md deleted file mode 100644 index 91d29da43..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-2.md +++ /dev/null @@ -1,6174 +0,0 @@ -### CreditMemoItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 -} -``` - - - -### CreditMemoItemInterface - -Credit memo item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Possible Types - -| CreditMemoItemInterface Types | -|----------------| -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | -| [`CreditMemoItem`](#creditmemoitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 -} -``` - - - -### CreditMemoTotal - -Contains credit memo price details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | - -#### Example - -```json -{ - "adjustment": Money, - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### Currency - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | -| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | - -#### Example - -```json -{ - "available_currency_codes": ["xyz789"], - "base_currency_code": "abc123", - "base_currency_symbol": "abc123", - "default_display_currecy_code": "abc123", - "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "abc123", - "exchange_rates": [ExchangeRate] -} -``` - - - -### CurrencyEnum - -The list of available currency codes. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""AFN"" -``` - - - -### CustomAttributeMetadata - -Defines an array of custom attributes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | - -#### Example - -```json -{"items": [Attribute]} -``` - - - -### CustomAttributeMetadataInterface - -An interface containing fields that define the EAV attribute. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | - -#### Possible Types - -| CustomAttributeMetadataInterface Types | -|----------------| -| [`AttributeMetadata`](#attributemetadata) | -| [`CatalogAttributeMetadata`](#catalogattributemetadata) | -| [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | - -#### Example - -```json -{ - "code": "4", - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": false, - "label": "xyz789", - "options": [CustomAttributeOptionInterface] -} -``` - - - -### CustomAttributeOptionInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | - -#### Possible Types - -| CustomAttributeOptionInterface Types | -|----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | - -#### Example - -```json -{ - "is_default": false, - "label": "abc123", - "value": "abc123" -} -``` - - - -### Customer - -Defines the customer name, addresses, and other details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | -| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | -| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](#string) | The customer's email address. Required. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | -| `group` - [`CustomerGroup`](#customergroup) | Name of the customer group assigned to the customer | -| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`Int`](#int) | The ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | -| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | -| `segments` - [`[CustomerSegment]`](#customersegment) | Customer segments associated with the current customer | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | -| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | -| `telephone` - [`String`](#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](#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. | - -#### Example - -```json -{ - "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": "xyz789", - "default_billing": "xyz789", - "default_shipping": "abc123", - "dob": "xyz789", - "email": "xyz789", - "firstname": "abc123", - "gender": 987, - "gift_registries": [GiftRegistry], - "gift_registry": GiftRegistry, - "group": CustomerGroup, - "group_id": 987, - "id": 123, - "is_subscribed": false, - "job_title": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "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": [CustomerSegment], - "status": "ACTIVE", - "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "xyz789", - "taxvat": "xyz789", - "team": CompanyTeam, - "telephone": "xyz789", - "wishlist": Wishlist, - "wishlist_v2": Wishlist, - "wishlists": [Wishlist] -} -``` - - - -### CustomerAddress - -Contains detailed information about a customer's billing or shipping address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | -| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | -| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. | -| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "abc123", - "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": "abc123", - "firstname": "abc123", - "id": 987, - "lastname": "abc123", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "abc123", - "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "xyz789" -} -``` - - - -### CustomerAddressAttribute - -Specifies the attribute code and value of a customer address attribute. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](#string) | The value assigned to the customer address attribute. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "xyz789" -} -``` - - - -### CustomerAddressAttributeInput - -Specifies the attribute code and value of a customer attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "abc123" -} -``` - - - -### CustomerAddressInput - -Contains details about a billing or shipping address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | | -| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | | -| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "city": "abc123", - "company": "xyz789", - "country_code": "AF", - "country_id": "AF", - "custom_attributes": [CustomerAddressAttributeInput], - "custom_attributesV2": [AttributeValueInput], - "default_billing": false, - "default_shipping": true, - "fax": "abc123", - "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" -} -``` - - - -### CustomerAddressRegion - -Defines the customer's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "xyz789", - "region_code": "abc123", - "region_id": 987 -} -``` - - - -### CustomerAddressRegionInput - -Defines the customer's state or province. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "xyz789", - "region_code": "xyz789", - "region_id": 123 -} -``` - - - -### CustomerAddresses - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer addresses. | - -#### Example - -```json -{ - "items": [CustomerAddress], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerAttributeMetadata - -Customer attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | - -#### Example - -```json -{ - "code": "4", - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": true, - "is_unique": false, - "label": "xyz789", - "multiline_count": 123, - "options": [CustomAttributeOptionInterface], - "sort_order": 123, - "validate_rules": [ValidationRule] -} -``` - - - -### CustomerCreateInput - -An input object for creating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | | -| `email` - [`String!`](#string) | The customer's email address. | -| `firstname` - [`String!`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", - "dob": "abc123", - "email": "xyz789", - "firstname": "abc123", - "gender": 987, - "is_subscribed": false, - "lastname": "abc123", - "middlename": "abc123", - "password": "abc123", - "prefix": "abc123", - "suffix": "abc123", - "taxvat": "xyz789" -} -``` - - - -### CustomerDownloadableProduct - -Contains details about a single downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date` - [`String`](#string) | The date and time the purchase was made. | -| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | - -#### Example - -```json -{ - "date": "abc123", - "download_url": "abc123", - "order_increment_id": "abc123", - "remaining_downloads": "abc123", - "status": "xyz789" -} -``` - - - -### CustomerDownloadableProducts - -Contains a list of downloadable products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | - -#### Example - -```json -{"items": [CustomerDownloadableProduct]} -``` - - - -### CustomerGroup - -Data of customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name of customer group. | - -#### Example - -```json -{"name": "xyz789"} -``` - - - -### CustomerInput - -An input object that assigns or updates customer attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | | -| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "date_of_birth": "xyz789", - "dob": "xyz789", - "email": "abc123", - "firstname": "abc123", - "gender": 987, - "is_subscribed": false, - "lastname": "xyz789", - "middlename": "xyz789", - "password": "abc123", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "xyz789" -} -``` - - - -### CustomerOrder - -Contains details about each of the customer's orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | -| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | -| `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | -| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | -| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `customer_info` - [`OrderCustomerInfo!`](#ordercustomerinfo) | Returns customer information from order. | -| `email` - [`String`](#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | -| `is_virtual` - [`Boolean!`](#boolean) | `TRUE` if the order is virtual | -| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](#string) | The order number. | -| `order_date` - [`String!`](#string) | The date the order was placed. | -| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | -| `order_status_change_date` - [`String!`](#string) | The date the order status was last updated. | -| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](#string) | The delivery method for the order. | -| `status` - [`String!`](#string) | The current status of the order. | -| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | - -#### Example - -```json -{ - "applied_coupons": [AppliedCoupon], - "applied_gift_cards": [ApplyGiftCardToOrder], - "available_actions": ["REORDER"], - "billing_address": OrderAddress, - "carrier": "xyz789", - "comments": [SalesCommentItem], - "created_at": "abc123", - "credit_memos": [CreditMemo], - "customer_info": OrderCustomerInfo, - "email": "abc123", - "gift_message": GiftMessage, - "gift_receipt_included": true, - "gift_wrapping": GiftWrapping, - "grand_total": 987.65, - "id": "4", - "increment_id": "abc123", - "invoices": [Invoice], - "is_virtual": true, - "items": [OrderItemInterface], - "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", - "order_date": "abc123", - "order_number": "xyz789", - "order_status_change_date": "abc123", - "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, - "returns": Returns, - "shipments": [OrderShipment], - "shipping_address": OrderAddress, - "shipping_method": "abc123", - "status": "xyz789", - "token": "xyz789", - "total": OrderTotal -} -``` - - - -### CustomerOrderSortInput - -CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | -| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "NUMBER"} -``` - - - -### CustomerOrderSortableField - -Specifies the field to use for sorting - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NUMBER` | Sorts customer orders by number | -| `CREATED_AT` | Sorts customer orders by created_at field | - -#### Example - -```json -""NUMBER"" -``` - - - -### CustomerOrders - -The collection of orders that match the conditions defined in the filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | -| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer orders. | - -#### Example - -```json -{ - "date_of_first_order": "abc123", - "items": [CustomerOrder], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerOrdersFilterInput - -Identifies the filter to use for filtering orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `grand_total` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order base grand total value. | -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | -| `order_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order created_at time. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filters by order status. | - -#### Example - -```json -{ - "grand_total": FilterRangeTypeInput, - "number": FilterStringTypeInput, - "order_date": FilterRangeTypeInput, - "status": FilterEqualTypeInput -} -``` - - - -### CustomerOutput - -Contains details about a newly-created or updated customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | - -#### Example - -```json -{"customer": Customer} -``` - - - -### CustomerPaymentTokens - -Contains payment tokens stored in the customer's vault. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | - -#### Example - -```json -{"items": [PaymentToken]} -``` - - - -### CustomerSegment - -Customer segment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `apply_to` - [`CustomerSegmentApplyTo!`](#customersegmentapplyto) | Customer segment is applicable to visitor, registered customer or both. | -| `description` - [`String`](#string) | Customer segment description. | -| `name` - [`String!`](#string) | Customer segment name. | - -#### Example - -```json -{ - "apply_to": "BOTH", - "description": "xyz789", - "name": "abc123" -} -``` - - - -### CustomerSegmentApplyTo - -Customer segment is applicable to visitor, registered customers or both. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BOTH` | Customer segment is applicable to visitor and registered customers. | -| `REGISTERED` | Customer segment is applicable to registered customers. | -| `VISITOR` | Customer segment is applicable to visitors/guests. | - -#### Example - -```json -""BOTH"" -``` - - - -### CustomerStoreCredit - -Contains store credit information with balance and history. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance_history` - [`CustomerStoreCreditHistory`](#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. | -| `current_balance` - [`Money`](#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | - -#### Example - -```json -{ - "balance_history": CustomerStoreCreditHistory, - "current_balance": Money, - "enabled": false -} -``` - - - -### CustomerStoreCreditHistory - -Lists changes to the amount of store credit available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of items returned. | - -#### Example - -```json -{ - "items": [CustomerStoreCreditHistoryItem], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### CustomerStoreCreditHistoryItem - -Contains store credit history information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `action` - [`String`](#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | - -#### Example - -```json -{ - "action": "abc123", - "actual_balance": Money, - "balance_change": Money, - "date_time_changed": "xyz789" -} -``` - - - -### CustomerToken - -Contains a customer authorization token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | - -#### Example - -```json -{"token": "xyz789"} -``` - - - -### CustomerUpdateInput - -An input object for updating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": true, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", - "dob": "abc123", - "firstname": "abc123", - "gender": 123, - "is_subscribed": true, - "lastname": "xyz789", - "middlename": "xyz789", - "prefix": "xyz789", - "suffix": "xyz789", - "taxvat": "xyz789" -} -``` - - - -### CustomizableAreaOption - -Contains information about a text area that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "xyz789", - "required": false, - "sort_order": 123, - "title": "abc123", - "uid": 4, - "value": CustomizableAreaValue -} -``` - - - -### CustomizableAreaValue - -Defines the price and sku of a product whose page contains a customized text area. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | - -#### Example - -```json -{ - "max_characters": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableCheckboxOption - -Contains information about a set of checkbox values that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 123, - "title": "abc123", - "uid": "4", - "value": [CustomizableCheckboxValue] -} -``` - - - -### CustomizableCheckboxValue - -Defines the price and sku of a product whose page contains a customized set of checkbox values. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | - -#### Example - -```json -{ - "option_type_id": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "abc123", - "uid": 4 -} -``` - - - -### CustomizableDateOption - -Contains information about a date picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "xyz789", - "required": true, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": CustomizableDateValue -} -``` - - - -### CustomizableDateTypeEnum - -Defines the customizable date type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `DATE` | | -| `DATE_TIME` | | -| `TIME` | | - -#### Example - -```json -""DATE"" -``` - - - -### CustomizableDateValue - -Defines the price and sku of a product whose page contains a customized date picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | - -#### Example - -```json -{ - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "type": "DATE", - "uid": "4" -} -``` - - - -### CustomizableDropDownOption - -Contains information about a drop down menu that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 987, - "title": "xyz789", - "uid": 4, - "value": [CustomizableDropDownValue] -} -``` - - - -### CustomizableDropDownValue - -Defines the price and sku of a product whose page contains a customized drop down menu. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableFieldOption - -Contains information about a text field that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | - -#### Example - -```json -{ - "option_id": 123, - "product_sku": "abc123", - "required": false, - "sort_order": 987, - "title": "xyz789", - "uid": "4", - "value": CustomizableFieldValue -} -``` - - - -### CustomizableFieldValue - -Defines the price and sku of a product whose page contains a customized text field. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | - -#### Example - -```json -{ - "max_characters": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableFileOption - -Contains information about a file picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "xyz789", - "required": false, - "sort_order": 123, - "title": "abc123", - "uid": "4", - "value": CustomizableFileValue -} -``` - - - -### CustomizableFileValue - -Defines the price and sku of a product whose page contains a customized file picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `file_extension` - [`String`](#string) | The file extension to accept. | -| `image_size_x` - [`Int`](#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](#int) | The maximum height of an image. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | - -#### Example - -```json -{ - "file_extension": "xyz789", - "image_size_x": 123, - "image_size_y": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableMultipleOption - -Contains information about a multiselect that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | - -#### Example - -```json -{ - "option_id": 987, - "required": true, - "sort_order": 987, - "title": "xyz789", - "uid": "4", - "value": [CustomizableMultipleValue] -} -``` - - - -### CustomizableMultipleValue - -Defines the price and sku of a product whose page contains a customized multiselect. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableOptionInput - -Defines a customizable option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`Int`](#int) | The customizable option ID of the product. | -| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](#string) | The string value of the option. | - -#### Example - -```json -{ - "id": 987, - "uid": 4, - "value_string": "abc123" -} -``` - - - -### CustomizableOptionInterface - -Contains basic information about a customizable option. It can be implemented by several types of configurable options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | - -#### Possible Types - -| CustomizableOptionInterface Types | -|----------------| -| [`CustomizableAreaOption`](#customizableareaoption) | -| [`CustomizableDateOption`](#customizabledateoption) | -| [`CustomizableDropDownOption`](#customizabledropdownoption) | -| [`CustomizableMultipleOption`](#customizablemultipleoption) | -| [`CustomizableFieldOption`](#customizablefieldoption) | -| [`CustomizableFileOption`](#customizablefileoption) | -| [`CustomizableRadioOption`](#customizableradiooption) | -| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | - -#### Example - -```json -{ - "option_id": 987, - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### CustomizableProductInterface - -Contains information about customizable product options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | - -#### Possible Types - -| CustomizableProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | - -#### Example - -```json -{"options": [CustomizableOptionInterface]} -``` - - - -### CustomizableRadioOption - -Contains information about a set of radio buttons that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | - -#### Example - -```json -{ - "option_id": 123, - "required": false, - "sort_order": 987, - "title": "xyz789", - "uid": 4, - "value": [CustomizableRadioValue] -} -``` - - - -### CustomizableRadioValue - -Defines the price and sku of a product whose page contains a customized set of radio buttons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### DeleteCompanyRoleOutput - -Contains the response to the request to delete the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyTeamOutput - -Contains the status of the request to delete a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyUserOutput - -Contains the response to the request to delete the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | - -#### Example - -```json -{"success": false} -``` - - - -### DeleteCompareListOutput - -Contains the results of the request to delete a compare list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | - -#### Example - -```json -{"result": true} -``` - - - -### DeleteNegotiableQuoteError - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | - -#### Example - -```json -NegotiableQuoteInvalidStateError -``` - - - -### DeleteNegotiableQuoteOperationFailure - -Contains details about a failed delete operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 -} -``` - - - -### DeleteNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | - -#### Example - -```json -NegotiableQuoteUidOperationSuccess -``` - - - -### DeleteNegotiableQuoteTemplateInput - -Specifies the quote template id of the quote template to delete - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### DeleteNegotiableQuotesInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | - -#### Example - -```json -{"quote_uids": [4]} -``` - - - -### DeleteNegotiableQuotesOutput - -Contains a list of undeleted negotiable quotes the company user can view. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | -| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | - -#### Example - -```json -{ - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} -``` - - - -### DeletePaymentTokenOutput - -Indicates whether the request succeeded and returns the remaining customer payment tokens. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | - -#### Example - -```json -{ - "customerPaymentTokens": CustomerPaymentTokens, - "result": false -} -``` - - - -### DeletePurchaseOrderApprovalRuleError - -Contains details about an error that occurred when deleting an approval rule . - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | -| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | - -#### Example - -```json -{"message": "abc123", "type": "UNDEFINED"} -``` - - - -### DeletePurchaseOrderApprovalRuleErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `NOT_FOUND` | | - -#### Example - -```json -""UNDEFINED"" -``` - - - -### DeletePurchaseOrderApprovalRuleInput - -Specifies the IDs of the approval rules to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | - -#### Example - -```json -{"approval_rule_uids": ["4"]} -``` - - - -### DeletePurchaseOrderApprovalRuleOutput - -Contains any errors encountered while attempting to delete approval rules. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | - -#### Example - -```json -{"errors": [DeletePurchaseOrderApprovalRuleError]} -``` - - - -### DeleteRequisitionListItemsOutput - -Output of the request to remove items from the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### DeleteRequisitionListOutput - -Indicates whether the request to delete the requisition list was successful. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | - -#### Example - -```json -{"requisition_lists": RequisitionLists, "status": false} -``` - - - -### DeleteWishlistOutput - -Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | - -#### Example - -```json -{"status": true, "wishlists": [Wishlist]} -``` - - - -### Discount - -Specifies the discount type and value for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | -| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](#string) | A description of the discount. | -| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](#float) | Quote line item discount value. | - -#### Example - -```json -{ - "amount": Money, - "applied_to": "ITEM", - "coupon": AppliedCoupon, - "is_discounting_locked": true, - "label": "abc123", - "type": "xyz789", - "value": 123.45 -} -``` - - - -### DownloadableCartItem - -An implementation for downloadable product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "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": 987.65, - "samples": [DownloadableProductSamples], - "uid": 4 -} -``` - - - -### DownloadableCreditMemoItem - -Defines downloadable product options for `CreditMemoItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 -} -``` - - - -### DownloadableFileTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | - -#### Example - -```json -""FILE"" -``` - - - -### DownloadableInvoiceItem - -Defines downloadable product options for `InvoiceItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 -} -``` - - - -### DownloadableItemsLinks - -Defines characteristics of the links for downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | - -#### Example - -```json -{ - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### DownloadableOrderItem - -Defines downloadable product options for `OrderItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "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": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### DownloadableProduct - -Defines a product that the shopper downloads. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | -| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "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": 987, - "erin_recommends": 123, - "features_bags": "xyz789", - "format": 987, - "gender": "xyz789", - "gift_message_available": false, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "links_purchased_separately": 123, - "links_title": "xyz789", - "manufacturer": 987, - "material": "abc123", - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", - "new": 987, - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "pattern": "abc123", - "performance_fabric": 123, - "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": 123, - "reviews": ProductReviews, - "rules": [CatalogRule], - "sale": 123, - "short_description": ComplexTextValue, - "size": 123, - "sku": "abc123", - "sleeve": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": true, - "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": "abc123", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website] -} -``` - - - -### DownloadableProductCartItemInput - -Defines a single downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | -| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "downloadable_product_links": [ - DownloadableProductLinksInput - ] -} -``` - - - -### DownloadableProductLinks - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | -| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](#float) | The price of the downloadable product. | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | - -#### Example - -```json -{ - "id": 987, - "is_shareable": false, - "link_type": "FILE", - "number_of_downloads": 123, - "price": 987.65, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "xyz789", - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### DownloadableProductLinksInput - -Contains the link ID for the downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | - -#### Example - -```json -{"link_id": 123} -``` - - - -### DownloadableProductSamples - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the sample. | - -#### Example - -```json -{ - "id": 123, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "xyz789", - "sort_order": 987, - "title": "abc123" -} -``` - - - -### DownloadableRequisitionListItem - -Contains details about downloadable products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "links": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples], - "uid": 4 -} -``` - - - -### DownloadableWishlistItem - -A downloadable product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "links_v2": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 123.45, - "samples": [DownloadableProductSamples] -} -``` - - - -### DuplicateNegotiableQuoteInput - -Identifies a quote to be duplicated - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | - -#### Example - -```json -{ - "duplicated_quote_uid": 4, - "quote_uid": "4" -} -``` - - - -### DuplicateNegotiableQuoteOutput - -Contains the newly created negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### DynamicBlock - -Contains a single dynamic block. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | - -#### Example - -```json -{ - "content": ComplexTextValue, - "uid": "4" -} -``` - - - -### DynamicBlockLocationEnum - -Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CONTENT` | | -| `HEADER` | | -| `FOOTER` | | -| `LEFT` | | -| `RIGHT` | | - -#### Example - -```json -""CONTENT"" -``` - - - -### DynamicBlockTypeEnum - -Indicates the selected Dynamic Blocks Rotator inline widget. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SPECIFIED` | | -| `CART_PRICE_RULE_RELATED` | | -| `CATALOG_PRICE_RULE_RELATED` | | - -#### Example - -```json -""SPECIFIED"" -``` - - - -### DynamicBlocks - -Contains an array of dynamic blocks. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | - -#### Example - -```json -{ - "items": [DynamicBlock], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### DynamicBlocksFilterInput - -Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | -| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | -| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | - -#### Example - -```json -{ - "dynamic_block_uids": ["4"], - "locations": ["CONTENT"], - "type": "SPECIFIED" -} -``` - - - -### EnteredCustomAttributeInput - -Contains details about a custom text attribute that the buyer entered. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "value": "abc123" -} -``` - - - -### EnteredOptionInput - -Defines a customer-entered option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](#string) | Text the customer entered. | - -#### Example - -```json -{"uid": 4, "value": "abc123"} -``` - - - -### EntityUrl - -Contains the `uid`, `relative_url`, and `type` attributes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | -| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Example - -```json -{ - "canonical_url": "xyz789", - "entity_uid": 4, - "id": 987, - "redirectCode": 987, - "relative_url": "xyz789", - "type": "CMS_PAGE" -} -``` - - - -### Error - -An error encountered while adding an item to the the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Possible Types - -| Error Types | -|----------------| -| [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](#insufficientstockerror) | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" -} -``` - - - -### ErrorInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Possible Types - -| ErrorInterface Types | -|----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### EstimateAddressInput - -Contains details about an address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | - -#### Example - -```json -{ - "country_code": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput -} -``` - - - -### EstimateTotalsInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | - -#### Example - -```json -{ - "address": EstimateAddressInput, - "cart_id": "abc123", - "shipping_method": ShippingMethodInput -} -``` - - - -### EstimateTotalsOutput - -Estimate totals output. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | Cart after totals estimation | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ExchangeRate - -Lists the exchange rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | - -#### Example - -```json -{"currency_to": "abc123", "rate": 987.65} -``` - - - -### FilterEqualTypeInput - -Defines a filter that matches the input exactly. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#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]`](#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 - -```json -{ - "eq": "xyz789", - "in": ["xyz789"] -} -``` - - - -### FilterMatchTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FULL` | | -| `PARTIAL` | | - -#### Example - -```json -""FULL"" -``` - - - -### FilterMatchTypeInput - -Defines a filter that performs a fuzzy search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `match` - [`String`](#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`](#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 - -```json -{"match": "xyz789", "match_type": "FULL"} -``` - - - -### FilterRangeTypeInput - -Defines a filter that matches a range of values, such as prices or dates. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | - -#### Example - -```json -{ - "from": "abc123", - "to": "abc123" -} -``` - - - -### FilterStringTypeInput - -Defines a filter for an input string. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | - -#### Example - -```json -{ - "eq": "abc123", - "in": ["abc123"], - "match": "abc123" -} -``` - - - -### FilterTypeInput - -Defines the comparison operators that can be used in a filter. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Equals. | -| `finset` - [`[String]`](#string) | | -| `from` - [`String`](#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](#string) | Greater than. | -| `gteq` - [`String`](#string) | Greater than or equal to. | -| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](#string) | Less than. | -| `lteq` - [`String`](#string) | Less than or equal to. | -| `moreq` - [`String`](#string) | More than or equal to. | -| `neq` - [`String`](#string) | Not equal to. | -| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](#string) | Not null. | -| `null` - [`String`](#string) | Is null. | -| `to` - [`String`](#string) | To. Must be used with the `from` field. | - -#### Example - -```json -{ - "eq": "abc123", - "finset": ["abc123"], - "from": "xyz789", - "gt": "xyz789", - "gteq": "xyz789", - "in": ["abc123"], - "like": "abc123", - "lt": "xyz789", - "lteq": "abc123", - "moreq": "xyz789", - "neq": "abc123", - "nin": ["abc123"], - "notnull": "abc123", - "null": "xyz789", - "to": "abc123" -} -``` - - - -### FixedProductTax - -A single FPT that can be applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | - -#### Example - -```json -{ - "amount": Money, - "label": "xyz789" -} -``` - - - -### FixedProductTaxDisplaySettings - -Lists display settings for the Fixed Product Tax. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""INCLUDE_FPT_WITHOUT_DETAILS"" -``` - - - -### Float - -The `Float` scalar type represents signed double-precision fractional -values as specified by -[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -#### Example - -```json -123.45 -``` - - - -### GenerateCustomerTokenAsAdminInput - -Identifies which customer requires remote shopping assistance. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | - -#### Example - -```json -{"customer_email": "xyz789"} -``` - - - -### GenerateCustomerTokenAsAdminOutput - -Contains the generated customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | - -#### Example - -```json -{"customer_token": "xyz789"} -``` - - - -### GenerateNegotiableQuoteFromTemplateInput - -Specifies the template id, from which to generate quote from. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### GenerateNegotiableQuoteFromTemplateOutput - -Contains the generated negotiable quote id. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | - -#### Example - -```json -{"negotiable_quote_uid": "4"} -``` - - - -### GetPaymentSDKOutput - -Gets the payment SDK URLs and values - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | - -#### Example - -```json -{"sdkParams": [PaymentSDKParamsItem]} -``` - - - -### GiftCardAccount - -Contains details about the gift card account. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`Money`](#money) | The balance remaining on the gift card. | -| `code` - [`String`](#string) | The gift card account code. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | - -#### Example - -```json -{ - "balance": Money, - "code": "abc123", - "expiration_date": "xyz789" -} -``` - - - -### GiftCardAccountInput - -Contains the gift card code. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | - -#### Example - -```json -{"gift_card_code": "abc123"} -``` - - - -### GiftCardAmounts - -Contains the value of a gift card, the website that generated the card, and related information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_id` - [`Int`](#int) | An internal attribute ID. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | -| `value` - [`Float`](#float) | The value of the gift card. | -| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | -| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | -| `website_value` - [`Float`](#float) | The value of the gift card. | - -#### Example - -```json -{ - "attribute_id": 123, - "uid": "4", - "value": 123.45, - "value_id": 987, - "website_id": 987, - "website_value": 987.65 -} -``` - - - -### GiftCardCartItem - -Contains details about a gift card that has been added to a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender. | -| `sender_name` - [`String!`](#string) | The name of the sender. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "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": 987.65, - "message": "xyz789", - "min_qty": 123.45, - "not_available_message": "xyz789", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "xyz789", - "recipient_name": "abc123", - "sender_email": "xyz789", - "sender_name": "abc123", - "uid": "4" -} -``` - - - -### GiftCardCreditMemoItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 -} -``` - - - -### GiftCardInvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 987.65 -} -``` - - - -### GiftCardItem - -Contains details about a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | - -#### Example - -```json -{ - "message": "abc123", - "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "xyz789" -} -``` - - - -### GiftCardOptions - -Contains details about the sender, recipient, and amount of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](#string) | A message to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | - -#### Example - -```json -{ - "amount": Money, - "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "abc123" -} -``` - - - -### GiftCardOrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "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": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### GiftCardProduct - -Defines properties of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | -| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | -| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "activity": "xyz789", - "allow_message": true, - "allow_open_amount": false, - "attribute_set_id": 987, - "canonical_url": "abc123", - "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": 123, - "features_bags": "xyz789", - "format": 123, - "gender": "abc123", - "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "giftcard_amounts": [GiftCardAmounts], - "giftcard_type": "VIRTUAL", - "id": 123, - "image": ProductImage, - "is_redeemable": false, - "is_returnable": "abc123", - "lifetime": 987, - "manufacturer": 987, - "material": "xyz789", - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 987, - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, - "name": "abc123", - "new": 123, - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "open_amount_max": 987.65, - "open_amount_min": 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": 987.65, - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, - "reviews": ProductReviews, - "rules": [CatalogRule], - "sale": 987, - "short_description": ComplexTextValue, - "size": 987, - "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": "xyz789", - "style_bags": "abc123", - "style_bottom": "abc123", - "style_general": "xyz789", - "swatch_image": "xyz789", - "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": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 123.45 -} -``` - - - -### GiftCardRequisitionListItem - -Contains details about gift cards added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "gift_card_options": GiftCardOptions, - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" -} -``` - - - -### GiftCardShipmentItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Example - -```json -{ - "gift_card": GiftCardItem, - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 -} -``` - - - -### GiftCardTypeEnum - -Specifies the gift card type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `VIRTUAL` | | -| `PHYSICAL` | | -| `COMBINED` | | - -#### Example - -```json -""VIRTUAL"" -``` - - - -### GiftCardWishlistItem - -A single gift card added to a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "gift_card_options": GiftCardOptions, - "id": "4", - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### GiftMessage - -Contains the text of a gift message, its sender, and recipient - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | - -#### Example - -```json -{ - "from": "abc123", - "message": "xyz789", - "to": "xyz789" -} -``` - - - -### GiftMessageInput - -Defines a gift message. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String!`](#string) | The name of the sender. | -| `message` - [`String!`](#string) | The text of the gift message. | -| `to` - [`String!`](#string) | The name of the recepient. | - -#### Example - -```json -{ - "from": "abc123", - "message": "xyz789", - "to": "xyz789" -} -``` - - - -### GiftOptionsPrices - -Contains prices for gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_items_incl_tax` - [`Money`](#money) | Price of the gift wrapping for all individual order items including tax. | -| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | -| `gift_wrapping_for_order_incl_tax` - [`Money`](#money) | Price of the gift wrapping for the whole order including tax. | -| `printed_card` - [`Money`](#money) | Price for the printed card. | -| `printed_card_incl_tax` - [`Money`](#money) | Price for the printed card including tax. | - -#### Example - -```json -{ - "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 -} -``` - - - -### GiftRegistry - -Contains details about a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | -| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | -| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | -| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | -| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | - -#### Example - -```json -{ - "created_at": "xyz789", - "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "abc123", - "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "xyz789", - "privacy_settings": "PRIVATE", - "registrants": [GiftRegistryRegistrant], - "shipping_address": CustomerAddress, - "status": "ACTIVE", - "type": GiftRegistryType, - "uid": "4" -} -``` - - - -### GiftRegistryDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": "4", - "group": "EVENT_INFORMATION", - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeGroup - -Defines the group type of a gift registry dynamic attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `EVENT_INFORMATION` | | -| `PRIVACY_SETTINGS` | | -| `REGISTRANT` | | -| `GENERAL_INFORMATION` | | -| `DETAILED_INFORMATION` | | -| `SHIPPING_ADDRESS` | | - -#### Example - -```json -""EVENT_INFORMATION"" -``` - - - -### GiftRegistryDynamicAttributeInput - -Defines a dynamic attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | - -#### Example - -```json -{"code": 4, "value": "xyz789"} -``` - - - -### GiftRegistryDynamicAttributeInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Possible Types - -| GiftRegistryDynamicAttributeInterface Types | -|----------------| -| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | -| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | - -#### Example - -```json -{ - "code": "4", - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeMetadata - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Example - -```json -{ - "attribute_group": "xyz789", - "code": "4", - "input_type": "abc123", - "is_required": true, - "label": "xyz789", - "sort_order": 987 -} -``` - - - -### GiftRegistryDynamicAttributeMetadataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Possible Types - -| GiftRegistryDynamicAttributeMetadataInterface Types | -|----------------| -| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | - -#### Example - -```json -{ - "attribute_group": "xyz789", - "code": 4, - "input_type": "xyz789", - "is_required": false, - "label": "xyz789", - "sort_order": 123 -} -``` - - - -### GiftRegistryItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Example - -```json -{ - "created_at": "abc123", - "note": "xyz789", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 987.65, - "uid": "4" -} -``` - - - -### GiftRegistryItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Possible Types - -| GiftRegistryItemInterface Types | -|----------------| -| [`GiftRegistryItem`](#giftregistryitem) | - -#### Example - -```json -{ - "created_at": "abc123", - "note": "abc123", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 123.45, - "uid": 4 -} -``` - - - -### GiftRegistryItemUserErrorInterface - -Contains the status and any errors that encountered with the customer's gift register item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Possible Types - -| GiftRegistryItemUserErrorInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{ - "status": true, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### GiftRegistryItemsUserError - -Contains details about an error that occurred when processing a gift registry item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | -| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | -| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | -| `message` - [`String!`](#string) | A localized error message. | -| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | - -#### Example - -```json -{ - "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": 4, - "message": "abc123", - "product_uid": 4 -} -``` - - - -### GiftRegistryItemsUserErrorType - -Defines the error type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""OUT_OF_STOCK"" -``` - - - -### GiftRegistryOutputInterface - -Contains the customer's gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | - -#### Possible Types - -| GiftRegistryOutputInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### GiftRegistryPrivacySettings - -Defines the privacy setting of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRIVATE` | | -| `PUBLIC` | | - -#### Example - -```json -""PRIVATE"" -``` - - - -### GiftRegistryRegistrant - -Contains details about a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryRegistrantDynamicAttribute - ], - "email": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", - "uid": 4 -} -``` - - - -### GiftRegistryRegistrantDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": "4", - "label": "abc123", - "value": "abc123" -} -``` - - - -### GiftRegistrySearchResult - -Contains the results of a gift registry search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | -| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](#string) | The location of the event. | -| `name` - [`String!`](#string) | The name of the gift registry owner. | -| `type` - [`String`](#string) | The type of event being held. | - -#### Example - -```json -{ - "event_date": "xyz789", - "event_title": "abc123", - "gift_registry_uid": "4", - "location": "xyz789", - "name": "abc123", - "type": "xyz789" -} -``` - - - -### GiftRegistryShippingAddressInput - -Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | -| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | - -#### Example - -```json -{"address_data": CustomerAddressInput, "address_id": 4} -``` - - - -### GiftRegistryStatus - -Defines the status of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ACTIVE` | | -| `INACTIVE` | | - -#### Example - -```json -""ACTIVE"" -``` - - - -### GiftRegistryType - -Contains details about a gift registry type. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | - -#### Example - -```json -{ - "dynamic_attributes_metadata": [ - GiftRegistryDynamicAttributeMetadataInterface - ], - "label": "abc123", - "uid": 4 -} -``` - - - -### GiftWrapping - -Contains details about the selected or available gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | -| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | -| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | -| `price` - [`Money!`](#money) | The gift wrapping price. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | - -#### Example - -```json -{ - "design": "abc123", - "id": 4, - "image": GiftWrappingImage, - "price": Money, - "uid": "4" -} -``` - - - -### GiftWrappingImage - -Points to an image associated with a gift wrapping option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | - -#### Example - -```json -{ - "label": "xyz789", - "url": "xyz789" -} -``` - - - -### GooglePayButtonStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | - -#### Example - -```json -{ - "color": "abc123", - "height": 987, - "type": "abc123" -} -``` - - - -### GooglePayConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "button_styles": GooglePayButtonStyles, - "code": "xyz789", - "is_visible": true, - "payment_intent": "abc123", - "payment_source": "abc123", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds_mode": "OFF", - "title": "abc123" -} -``` - - - -### GooglePayMethodInput - -Google Pay inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "xyz789" -} -``` - - - -### GroupedProduct - -Defines a grouped product, which consists of simple standalone products that are presented as a group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "activity": "abc123", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "collar": "abc123", - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 123, - "features_bags": "xyz789", - "format": 123, - "gender": "abc123", - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "items": [GroupedProductItem], - "manufacturer": 987, - "material": "abc123", - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "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": "abc123", - "pattern": "abc123", - "performance_fabric": 123, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 987, - "quantity": 987.65, - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, - "reviews": ProductReviews, - "rules": [CatalogRule], - "sale": 123, - "short_description": ComplexTextValue, - "size": 987, - "sku": "abc123", - "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": "xyz789", - "style_bottom": "xyz789", - "style_general": "abc123", - "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": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website], - "weight": 987.65 -} -``` - - - -### GroupedProductItem - -Contains information about an individual grouped product item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | -| `qty` - [`Float`](#float) | The quantity of this grouped product item. | - -#### Example - -```json -{ - "position": 987, - "product": ProductInterface, - "qty": 123.45 -} -``` - - - -### GroupedProductWishlistItem - -A grouped product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### GuestOrderCancelInput - -Input to retrieve a guest order based on token. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `reason` - [`String!`](#string) | Cancellation reason. | -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{ - "reason": "xyz789", - "token": "abc123" -} -``` - - - -### HostedFieldsConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cc_vault_code` - [`String`](#string) | Vault payment method code | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds` - [`Boolean`](#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "cc_vault_code": "xyz789", - "code": "xyz789", - "is_vault_enabled": true, - "is_visible": true, - "payment_intent": "xyz789", - "payment_source": "xyz789", - "requires_card_details": false, - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "three_ds": true, - "three_ds_mode": "OFF", - "title": "abc123" -} -``` - - - -### HostedFieldsInput - -Hosted Fields payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cardBin` - [`String`](#string) | Card bin number | -| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | -| `cardLast4` - [`String`](#string) | Last four digits of the card | -| `holderName` - [`String`](#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cardBin": "abc123", - "cardExpiryMonth": "abc123", - "cardExpiryYear": "xyz789", - "cardLast4": "xyz789", - "holderName": "xyz789", - "is_active_payment_token_enabler": false, - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "xyz789" -} -``` - - - -### HostedProInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "return_url": "xyz789" -} -``` - - - -### HostedProUrl - -Contains the secure URL used for the Payments Pro Hosted Solution payment method. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | - -#### Example - -```json -{"secure_form_url": "xyz789"} -``` - - - -### HostedProUrlInput - -Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### HttpQueryParameter - -Contains target path parameters. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "abc123" -} -``` - - - -### ID - -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 - -```json -"4" -``` - - - -### ImageSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{ - "thumbnail": "abc123", - "value": "abc123" -} -``` - - - -### InputFilterEnum - -List of templates/filters applied to customer attribute input. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""NONE"" -``` - - - -### InsufficientStockError - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | -| `quantity` - [`Float`](#float) | Amount of available stock | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "quantity": 123.45 -} -``` - - - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. - -#### Example - -```json -987 -``` - - - -### InternalError - -Contains an error message when an internal error occurred. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "xyz789"} -``` - - - -### Invoice - -Contains invoice details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | -| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | -| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](#string) | Sequential invoice number. | -| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": 4, - "items": [InvoiceItemInterface], - "number": "xyz789", - "total": InvoiceTotal -} -``` - - - -### InvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### InvoiceItemInterface - -Contains detailes about invoiced items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Possible Types - -| InvoiceItemInterface Types | -|----------------| -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | -| [`InvoiceItem`](#invoiceitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 -} -``` - - - -### InvoiceTotal - -Contains price details from an invoice. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### IsCompanyAdminEmailAvailableOutput - -Contains the response of a company admin email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsCompanyEmailAvailableOutput - -Contains the response of a company email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsCompanyRoleNameAvailableOutput - -Contains the response of a role name validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | - -#### Example - -```json -{"is_role_name_available": false} -``` - - - -### IsCompanyUserEmailAvailableOutput - -Contains the response of a company user email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsEmailAvailableOutput - -Contains the result of the `isEmailAvailable` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### ItemNote - -The note object for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | -| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | -| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | -| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | -| `note` - [`String`](#string) | Note text. | -| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | - -#### Example - -```json -{ - "created_at": "abc123", - "creator_id": 123, - "creator_type": 123, - "negotiable_quote_item_uid": 4, - "note": "abc123", - "note_uid": "4" -} -``` - - - -### ItemSelectedBundleOption - -A list of options of the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](#string) | The label of the option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | -| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | - -#### Example - -```json -{ - "id": "4", - "label": "xyz789", - "uid": "4", - "values": [ItemSelectedBundleOptionValue] -} -``` - - - -### ItemSelectedBundleOptionValue - -A list of values for the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](#money) | The price of the child bundle product. | -| `product_name` - [`String!`](#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | -| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | - -#### Example - -```json -{ - "id": "4", - "price": Money, - "product_name": "abc123", - "product_sku": "xyz789", - "quantity": 987.65, - "uid": 4 -} -``` - - - -### KeyValue - -Contains a key-value pair. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name part of the key/value pair. | -| `value` - [`String`](#string) | The value part of the key/value pair. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### LayerFilter - -Contains information for rendering layered navigation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | - -#### Example - -```json -{ - "filter_items": [LayerFilterItemInterface], - "filter_items_count": 987, - "name": "xyz789", - "request_var": "xyz789" -} -``` - - - -### LayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 123, - "label": "abc123", - "value_string": "xyz789" -} -``` - - - -### LayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Possible Types - -| LayerFilterItemInterface Types | -|----------------| -| [`LayerFilterItem`](#layerfilteritem) | -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{ - "items_count": 987, - "label": "abc123", - "value_string": "abc123" -} -``` - - - -### LineItemNoteInput - -Sets quote item note. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `note` - [`String`](#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "note": "xyz789", - "quote_item_uid": 4, - "quote_uid": "4" -} -``` - - - -### MediaGalleryEntry - -Defines characteristics about images and videos associated with a specific product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](#string) | The path of the image on the server. | -| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](#string) | Either `image` or `video`. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | - -#### Example - -```json -{ - "content": ProductMediaGalleryEntriesContent, - "disabled": false, - "file": "abc123", - "id": 123, - "label": "xyz789", - "media_type": "xyz789", - "position": 987, - "types": ["abc123"], - "uid": "4", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### MediaGalleryInterface - -Contains basic information about a product image or video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Possible Types - -| MediaGalleryInterface Types | -|----------------| -| [`ProductImage`](#productimage) | -| [`ProductVideo`](#productvideo) | - -#### Example - -```json -{ - "disabled": false, - "label": "abc123", - "position": 123, - "url": "xyz789" -} -``` - - - -### MessageStyleLogo - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | - -#### Example - -```json -{"type": "abc123"} -``` - - - -### MessageStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `layout` - [`String`](#string) | The message layout | -| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | - -#### Example - -```json -{ - "layout": "abc123", - "logo": MessageStyleLogo -} -``` - - - -### Money - -Defines a monetary value, including a numeric value and a currency code. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](#float) | A number expressing a monetary value. | - -#### Example - -```json -{"currency": "AFN", "value": 987.65} -``` - - - -### MoveCartItemsToGiftRegistryOutput - -Contains the customer's gift registry and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Example - -```json -{ - "gift_registry": GiftRegistry, - "status": true, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### MoveItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be moved. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | - -#### Example - -```json -{"requisitionListItemUids": ["4"]} -``` - - - -### MoveItemsBetweenRequisitionListsOutput - -Output of the request to move items to another requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | - -#### Example - -```json -{ - "destination_requisition_list": RequisitionList, - "source_requisition_list": RequisitionList -} -``` - - - -### MoveLineItemToRequisitionListInput - -Move Line Item to Requisition List. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | - -#### Example - -```json -{"quote_item_uid": 4, "quote_uid": 4, "requisition_list_uid": 4} -``` - - - -### MoveLineItemToRequisitionListOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### MoveProductsBetweenWishlistsOutput - -Contains the source and target wish lists after moving products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | - -#### Example - -```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-a-b.md new file mode 100644 index 000000000..789acd99e --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-a-b.md @@ -0,0 +1,2481 @@ +## Types + +### AcceptNegotiableQuoteTemplateInput + +Specifies the quote template id to accept quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": "4"} +``` + + + +### AddBundleProductsToCartInput + +Defines the bundle products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [BundleProductCartItemInput] +} +``` + + + +### AddBundleProductsToCartOutput + +Contains details about the cart after adding bundle products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddConfigurableProductsToCartInput + +Defines the configurable products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [ConfigurableProductCartItemInput] +} +``` + + + +### AddConfigurableProductsToCartOutput + +Contains details about the cart after adding configurable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddDownloadableProductsToCartInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [DownloadableProductCartItemInput] +} +``` + + + +### AddDownloadableProductsToCartOutput + +Contains details about the cart after adding downloadable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddGiftRegistryRegistrantInput + +Defines a new registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](#string) | The email address of the registrant. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "abc123", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### AddGiftRegistryRegistrantsOutput + +Contains the results of a request to add registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### AddProductsToCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](#error) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [Error] +} +``` + + + +### AddProductsToCompareListInput + +Contains products to add to an existing compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": [4], "uid": 4} +``` + + + +### AddProductsToRequisitionListOutput + +Output of the request to add products to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### AddProductsToWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### AddPurchaseOrderCommentInput + +Contains the comment to be added to a purchase order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | + +#### Example + +```json +{ + "comment": "abc123", + "purchase_order_uid": 4 +} +``` + + + +### AddPurchaseOrderCommentOutput + +Contains the successfully added comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | + +#### Example + +```json +{"comment": PurchaseOrderComment} +``` + + + +### AddPurchaseOrderItemsToCartInput + +Defines the purchase order and cart to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "purchase_order_uid": "4", + "replace_existing_cart_items": true +} +``` + + + +### AddRequisitionListItemToCartUserError + +Contains details about why an attempt to add items to the requistion list failed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | A description of the error. | +| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | + +#### Example + +```json +{ + "message": "abc123", + "type": "OUT_OF_STOCK" +} +``` + + + +### AddRequisitionListItemToCartUserErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OUT_OF_STOCK` | | +| `UNAVAILABLE_SKU` | | +| `OPTIONS_UPDATED` | | +| `LOW_QUANTITY` | | + +#### Example + +```json +""OUT_OF_STOCK"" +``` + + + +### AddRequisitionListItemsToCartOutput + +Output of the request to add items in a requisition list to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | +| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | + +#### Example + +```json +{ + "add_requisition_list_items_to_cart_user_errors": [ + AddRequisitionListItemToCartUserError + ], + "cart": Cart, + "status": false +} +``` + + + +### AddReturnCommentInput + +Defines a return comment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String!`](#string) | The text added to the return request. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "comment_text": "abc123", + "return_uid": "4" +} +``` + + + +### AddReturnCommentOutput + +Contains details about the return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | The modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### AddReturnTrackingInput + +Defines tracking information to be added to the return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | + +#### Example + +```json +{ + "carrier_uid": 4, + "return_uid": "4", + "tracking_number": "xyz789" +} +``` + + + +### AddReturnTrackingOutput + +Contains the response after adding tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | + +#### Example + +```json +{ + "return": Return, + "return_shipping_tracking": ReturnShippingTracking +} +``` + + + +### AddSimpleProductsToCartInput + +Defines the simple and group products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [SimpleProductCartItemInput] +} +``` + + + +### AddSimpleProductsToCartOutput + +Contains details about the cart after adding simple or group products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddVirtualProductsToCartInput + +Defines the virtual products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [VirtualProductCartItemInput] +} +``` + + + +### AddVirtualProductsToCartOutput + +Contains details about the cart after adding virtual products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddWishlistItemsToCartOutput + +Contains the resultant wish list and any error information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "add_wishlist_items_to_cart_user_errors": [ + WishlistCartUserInputError + ], + "status": false, + "wishlist": Wishlist +} +``` + + + +### Aggregation + +Contains information for each filterable option (such as price, category `UID`, and custom attributes). + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](#int) | The number of options in the aggregation group. | +| `label` - [`String`](#string) | The aggregation display name. | +| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | +| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "count": 123, + "label": "xyz789", + "options": [AggregationOption], + "position": 987 +} +``` + + + +### AggregationOption + +An implementation of `AggregationOptionInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Example + +```json +{ + "count": 987, + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AggregationOptionInterface + +Defines aggregation option fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Possible Types + +| AggregationOptionInterface Types | +|----------------| +| [`AggregationOption`](#aggregationoption) | + +#### Example + +```json +{ + "count": 123, + "label": "abc123", + "value": "abc123" +} +``` + + + +### AggregationsCategoryFilterInput + +Filter category aggregations in layered navigation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | + +#### Example + +```json +{"includeDirectChildrenOnly": false} +``` + + + +### AggregationsFilterInput + +An input object that specifies the filters used in product aggregations. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | + +#### Example + +```json +{"category": AggregationsCategoryFilterInput} +``` + + + +### ApplePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": ButtonStyles, + "code": "xyz789", + "is_visible": true, + "payment_intent": "abc123", + "payment_source": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "abc123" +} +``` + + + +### ApplePayMethodInput + +Apple Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### AppliedCoupon + +Contains the applied coupon code. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | + +#### Example + +```json +{"code": "abc123"} +``` + + + +### AppliedGiftCard + +Contains an applied gift card with applied and remaining balance. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | +| `code` - [`String`](#string) | The gift card account code. | +| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "xyz789", + "current_balance": Money, + "expiration_date": "xyz789" +} +``` + + + +### AppliedStoreCredit + +Contains the applied and current balances. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | + +#### Example + +```json +{ + "applied_balance": Money, + "current_balance": Money, + "enabled": true +} +``` + + + +### ApplyCouponToCartInput + +Specifies the coupon code to apply to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](#string) | A valid coupon code. | + +#### Example + +```json +{ + "cart_id": "abc123", + "coupon_code": "abc123" +} +``` + + + +### ApplyCouponToCartOutput + +Contains details about the cart after applying a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyCouponsStrategy + +The strategy to apply coupons to the cart. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""APPEND"" +``` + + + +### ApplyCouponsToCartInput + +Apply coupons to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "coupon_codes": ["abc123"], + "type": "APPEND" +} +``` + + + +### ApplyGiftCardToCartInput + +Defines the input required to run the `applyGiftCardToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_card_code": "abc123" +} +``` + + + +### ApplyGiftCardToCartOutput + +Defines the possible output for the `applyGiftCardToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyGiftCardToOrder + +Contains applied gift cards with gift card code and amount. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](#string) | The gift card account code. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "xyz789" +} +``` + + + +### ApplyRewardPointsToCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyStoreCreditToCartInput + +Defines the input required to run the `applyStoreCreditToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### ApplyStoreCreditToCartOutput + +Defines the possible output for the `applyStoreCreditToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AreaInput + +AreaInput defines the parameters which will be used for filter by specified location. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `radius` - [`Int!`](#int) | The radius for the search in KM. | +| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | + +#### Example + +```json +{"radius": 123, "search_term": "xyz789"} +``` + + + +### AssignCompareListToCustomerOutput + +Contains the results of the request to assign a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | + +#### Example + +```json +{"compare_list": CompareList, "result": true} +``` + + + +### Attribute + +Contains details about the attribute, including the code and type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | +| `attribute_type` - [`String`](#string) | The data type of the attribute. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "attribute_options": [AttributeOption], + "attribute_type": "abc123", + "entity_type": "xyz789", + "input_type": "abc123", + "storefront_properties": StorefrontProperties +} +``` + + + +### AttributeEntityTypeEnum + +List of all entity types. Populated by the modules introducing EAV entities. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CATALOG_PRODUCT` | | +| `CATALOG_CATEGORY` | | +| `CUSTOMER` | | +| `CUSTOMER_ADDRESS` | | +| `RMA_ITEM` | | + +#### Example + +```json +""CATALOG_PRODUCT"" +``` + + + +### AttributeFilterInput + +An input object that specifies the filters used for attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | + +#### Example + +```json +{ + "is_comparable": true, + "is_filterable": true, + "is_filterable_in_search": true, + "is_html_allowed_on_front": false, + "is_searchable": false, + "is_used_for_customer_segment": false, + "is_used_for_price_rules": false, + "is_used_for_promo_rules": false, + "is_visible_in_advanced_search": true, + "is_visible_on_front": true, + "is_wysiwyg_enabled": false, + "used_in_product_listing": true +} +``` + + + +### AttributeFrontendInputEnum + +EAV attribute frontend input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `WEIGHT` | | +| `UNDEFINED` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### AttributeInput + +Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "entity_type": "xyz789" +} +``` + + + +### AttributeInputSelectedOption + +Specifies selected option for a select or multiselect attribute value. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### AttributeMetadata + +Base EAV implementation of CustomAttributeMetadataInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | + +#### Example + +```json +{ + "code": 4, + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "is_required": false, + "is_unique": false, + "label": "abc123", + "options": [CustomAttributeOptionInterface] +} +``` + + + +### AttributeMetadataError + +Attribute metadata retrieval error. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | + +#### Example + +```json +{ + "message": "abc123", + "type": "ENTITY_NOT_FOUND" +} +``` + + + +### AttributeMetadataErrorType + +Attribute metadata retrieval error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ENTITY_NOT_FOUND"" +``` + + + +### AttributeOption + +Defines an attribute option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label assigned to the attribute option. | +| `value` - [`String`](#string) | The attribute option value. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeOptionMetadata + +Base EAV implementation of CustomAttributeOptionInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{ + "is_default": false, + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOption + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### AttributeSelectedOptionInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Possible Types + +| AttributeSelectedOptionInterface Types | +|----------------| +| [`AttributeSelectedOption`](#attributeselectedoption) | + +#### Example + +```json +{ + "label": "abc123", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOptions + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | + +#### Example + +```json +{ + "code": "4", + "selected_options": [AttributeSelectedOptionInterface] +} +``` + + + +### AttributeValue + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `value` - [`String!`](#string) | The attribute value. | + +#### Example + +```json +{"code": 4, "value": "xyz789"} +``` + + + +### AttributeValueInput + +Specifies the value for attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | +| `value` - [`String`](#string) | The value assigned to the attribute. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "selected_options": [AttributeInputSelectedOption], + "value": "xyz789" +} +``` + + + +### AttributeValueInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | + +#### Possible Types + +| AttributeValueInterface Types | +|----------------| +| [`AttributeValue`](#attributevalue) | +| [`AttributeSelectedOptions`](#attributeselectedoptions) | + +#### Example + +```json +{"code": "4"} +``` + + + +### AttributesFormOutput + +Metadata of EAV attributes associated to form + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AttributesMetadataOutput + +Metadata of EAV attributes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AvailableCurrency + +Defines the code and symbol of a currency that can be used for purchase orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](#string) | Currency symbol, for example $. | + +#### Example + +```json +{"code": "AFN", "symbol": "xyz789"} +``` + + + +### AvailablePaymentMethod + +Describes a payment method that the shopper can use to pay for the order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "is_deferred": false, + "title": "xyz789" +} +``` + + + +### AvailableShippingMethod + +Contains details about the possible shipping methods and carriers. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `error_message` - [`String`](#string) | Describes an error condition. | +| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "available": true, + "base_amount": Money, + "carrier_code": "xyz789", + "carrier_title": "xyz789", + "error_message": "abc123", + "method_code": "abc123", + "method_title": "abc123", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### BatchMutationStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUCCESS` | | +| `FAILURE` | | +| `MIXED_RESULTS` | | + +#### Example + +```json +""SUCCESS"" +``` + + + +### BillingAddressInput + +Defines the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | +| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 987, + "same_as_shipping": true, + "use_for_shipping": false +} +``` + + + +### BillingAddressPaymentSourceInput + +The billing address information + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_line_1` - [`String`](#string) | The first line of the address | +| `address_line_2` - [`String`](#string) | The second line of the address | +| `city` - [`String`](#string) | The city of the address | +| `country_code` - [`String!`](#string) | The country of the address | +| `postal_code` - [`String`](#string) | The postal code of the address | +| `region` - [`String`](#string) | The region of the address | + +#### Example + +```json +{ + "address_line_1": "abc123", + "address_line_2": "abc123", + "city": "abc123", + "country_code": "abc123", + "postal_code": "abc123", + "region": "abc123" +} +``` + + + +### BillingCartAddress + +Contains details about the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "city": "xyz789", + "company": "abc123", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "xyz789", + "id": 987, + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "abc123", + "region": CartAddressRegion, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "abc123", + "uid": "abc123", + "vat_id": "xyz789" +} +``` + + + +### Boolean + +The `Boolean` scalar type represents `true` or `false`. + +#### Example + +```json +true +``` + + + +### BraintreeCcVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "abc123", + "public_hash": "xyz789" +} +``` + + + +### BraintreeInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#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!`](#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!`](#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | + +#### Example + +```json +{ + "device_data": "xyz789", + "is_active_payment_token_enabler": false, + "payment_method_nonce": "xyz789" +} +``` + + + +### BraintreeVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "abc123", + "public_hash": "abc123" +} +``` + + + +### Breadcrumb + +Contains details about an individual category that comprises a breadcrumb. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](#int) | The category level. | +| `category_name` - [`String`](#string) | The display name of the category. | +| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](#string) | The URL key of the category. | +| `category_url_path` - [`String`](#string) | The URL path of the category. | + +#### Example + +```json +{ + "category_id": 123, + "category_level": 987, + "category_name": "abc123", + "category_uid": "4", + "category_url_key": "xyz789", + "category_url_path": "xyz789" +} +``` + + + +### BundleCartItem + +An implementation for bundle product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "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": 987.65, + "min_qty": 987.65, + "not_available_message": "abc123", + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### BundleCreditMemoItem + +Defines bundle product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 +} +``` + + + +### BundleInvoiceItem + +Defines bundle product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### BundleItem + +Defines an individual item within a bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | +| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | +| `sku` - [`String`](#string) | The SKU of the bundle product. | +| `title` - [`String`](#string) | The display name of the item. | +| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | + +#### Example + +```json +{ + "option_id": 123, + "options": [BundleItemOption], + "position": 987, + "price_range": PriceRange, + "required": true, + "sku": "abc123", + "title": "abc123", + "type": "xyz789", + "uid": 4 +} +``` + + + +### BundleItemOption + +Defines the characteristics that comprise a specific bundle item and its options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | +| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | +| `label` - [`String`](#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | + +#### Example + +```json +{ + "can_change_quantity": true, + "id": 123, + "is_default": false, + "label": "xyz789", + "position": 123, + "price": 123.45, + "price_type": "FIXED", + "product": ProductInterface, + "qty": 123.45, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### BundleOptionInput + +Defines the input for a bundle option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`Int!`](#int) | The ID of the option. | +| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | + +#### Example + +```json +{ + "id": 123, + "quantity": 987.65, + "value": ["xyz789"] +} +``` + + + +### BundleOrderItem + +Defines bundle product options for `OrderItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "parent_sku": "abc123", + "prices": OrderItemPrices, + "product": ProductInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "product_type": "xyz789", + "product_url_key": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 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": "abc123" +} +``` + + + +### BundleProduct + +Defines basic features of a bundle product and contains multiple BundleItems. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | +| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | +| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "abc123", + "attribute_set_id": 123, + "canonical_url": "xyz789", + "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, + "dynamic_price": false, + "dynamic_sku": false, + "dynamic_weight": false, + "eco_collection": 123, + "erin_recommends": 987, + "features_bags": "abc123", + "format": 123, + "gender": "abc123", + "gift_message_available": true, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "id": 123, + "image": ProductImage, + "is_returnable": "xyz789", + "items": [BundleItem], + "manufacturer": 987, + "material": "abc123", + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "abc123", + "new": 123, + "new_from_date": "abc123", + "new_to_date": "abc123", + "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": 987.65, + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 987, + "ship_bundle_items": "TOGETHER", + "short_description": ComplexTextValue, + "size": 987, + "sku": "abc123", + "sleeve": "abc123", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "xyz789", + "staged": true, + "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": "abc123", + "uid": 4, + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### BundleProductCartItemInput + +Defines a single bundle product. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | + +#### Example + +```json +{ + "bundle_options": [BundleOptionInput], + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### BundleRequisitionListItem + +Contains details about bundle products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | + +#### Example + +```json +{ + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleShipmentItem + +Defines bundle product options for `ShipmentItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### BundleWishlistItem + +Defines bundle product options for `WishlistItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### ButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `label` - [`String`](#string) | The button label | +| `layout` - [`String`](#string) | The button layout | +| `shape` - [`String`](#string) | The button shape | +| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | +| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | + +#### Example + +```json +{ + "color": "xyz789", + "height": 123, + "label": "xyz789", + "layout": "abc123", + "shape": "abc123", + "tagline": true, + "use_default_height": true +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-1.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md similarity index 62% rename from src/pages/includes/autogenerated/graphql-api-2-4-8-types-1.md rename to src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md index 98984db8c..95b05482f 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-1.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-c-e.md @@ -1,3062 +1,2719 @@ ## Types -### AcceptNegotiableQuoteTemplateInput +### CancelNegotiableQuoteTemplateInput -Specifies the quote template id to accept quote template. +Specifies the quote template id of the quote template to cancel #### Input Fields | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{ + "cancellation_comment": "abc123", + "template_id": 4 +} ``` -### AddBundleProductsToCartInput - -Defines the bundle products to add to the cart. +### CancelOrderError -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [BundleProductCartItemInput] + "code": "ORDER_CANCELLATION_DISABLED", + "message": "abc123" } ``` -### AddBundleProductsToCartOutput - -Contains details about the cart after adding bundle products. +### CancelOrderErrorCode -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `ORDER_CANCELLATION_DISABLED` | | +| `UNDEFINED` | | +| `UNAUTHORISED` | | +| `ORDER_NOT_FOUND` | | +| `PARTIAL_ORDER_ITEM_SHIPPED` | | +| `INVALID_ORDER_STATUS` | | #### Example ```json -{"cart": Cart} +""ORDER_CANCELLATION_DISABLED"" ``` -### AddConfigurableProductsToCartInput +### CancelOrderInput -Defines the configurable products to add to the cart. +Defines the order to cancel. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](#string) | Cancellation reason. | #### Example ```json { - "cart_id": "abc123", - "cart_items": [ConfigurableProductCartItemInput] + "order_id": "4", + "reason": "xyz789" } ``` -### AddConfigurableProductsToCartOutput +### CancelOrderOutput -Contains details about the cart after adding configurable products. +Contains the updated customer order and error message if any. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddDownloadableProductsToCartInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `errorV2` - [`CancelOrderError`](#cancelordererror) | | +| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [DownloadableProductCartItemInput] + "error": "abc123", + "errorV2": CancelOrderError, + "order": CustomerOrder } ``` -### AddDownloadableProductsToCartOutput - -Contains details about the cart after adding downloadable products. +### CancellationReason #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `description` - [`String!`](#string) | | #### Example ```json -{"cart": Cart} +{"description": "abc123"} ``` -### AddGiftRegistryRegistrantInput - -Defines a new registrant. +### Card -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](#string) | The email address of the registrant. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | +| Field Name | Description | +|------------|-------------| +| `bin_details` - [`CardBin`](#cardbin) | Card bin details | +| `card_expiry_month` - [`String`](#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](#string) | Expiration year of the card | +| `last_digits` - [`String`](#string) | Last four digits of the card | +| `name` - [`String`](#string) | Name on the card | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789" + "bin_details": CardBin, + "card_expiry_month": "abc123", + "card_expiry_year": "xyz789", + "last_digits": "xyz789", + "name": "xyz789" } ``` -### AddGiftRegistryRegistrantsOutput - -Contains the results of a request to add registrants. +### CardBin #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `bin` - [`String`](#string) | Card bin number | #### Example ```json -{"gift_registry": GiftRegistry} +{"bin": "abc123"} ``` -### AddProductsToCartOutput +### CardPaymentSourceInput -Contains details about the cart after adding products to it. +The card payment source information -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after products have been added. | -| `user_errors` - [`[Error]!`](#error) | Contains errors encountered while adding an item to the cart. | +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](#string) | The name on the cardholder | #### Example ```json { - "cart": Cart, - "user_errors": [Error] + "billing_address": BillingAddressPaymentSourceInput, + "name": "abc123" } ``` -### AddProductsToCompareListInput +### CardPaymentSourceOutput -Contains products to add to an existing compare list. +The card payment source information -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| Field Name | Description | +|------------|-------------| +| `brand` - [`String`](#string) | The brand of the card | +| `expiry` - [`String`](#string) | The expiry of the card | +| `last_digits` - [`String`](#string) | The last digits of the card | #### Example ```json { - "products": ["4"], - "uid": "4" + "brand": "abc123", + "expiry": "abc123", + "last_digits": "xyz789" } ``` -### AddProductsToRequisitionListOutput +### Cart -Output of the request to add products to a requisition list. +Contains the contents and other details about a guest or customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. *(Deprecated: Use `itemsV2` instead.)* | +| `itemsV2` - [`CartItems`](#cartitems) | | +| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `rules` - [`[CartRule]`](#cartrule) | Provides applied cart rules in the current active cart | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "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": false, + "gift_wrapping": GiftWrapping, + "id": 4, + "is_virtual": false, + "items": [CartItemInterface], + "itemsV2": CartItems, + "prices": CartPrices, + "printed_card_included": true, + "rules": [CartRule], + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [ShippingCartAddress], + "total_quantity": 987.65 +} ``` -### AddProductsToWishlistOutput +### CartAddressCountry -Contains the customer's wish list and any errors encountered. +Contains details the country in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `code` - [`String!`](#string) | The country code. | +| `label` - [`String!`](#string) | The display label for the country. | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "code": "xyz789", + "label": "xyz789" } ``` -### AddPurchaseOrderCommentInput +### CartAddressInput -Contains the comment to be added to a purchase order. +Defines the billing or shipping address to be applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "comment": "xyz789", - "purchase_order_uid": "4" + "city": "abc123", + "company": "xyz789", + "country_code": "xyz789", + "custom_attributes": [AttributeValueInput], + "fax": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": "abc123", + "region_id": 987, + "save_in_address_book": true, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "abc123" } ``` -### AddPurchaseOrderCommentOutput - -Contains the successfully added comment. +### CartAddressInterface #### Fields | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | - -#### Example - -```json -{"comment": PurchaseOrderComment} -``` - - - -### AddPurchaseOrderItemsToCartInput - -Defines the purchase order and cart to act on. +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | -| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | +| CartAddressInterface Types | +|----------------| +| [`ShippingCartAddress`](#shippingcartaddress) | +| [`BillingCartAddress`](#billingcartaddress) | #### Example ```json { - "cart_id": "abc123", - "purchase_order_uid": 4, - "replace_existing_cart_items": true + "city": "xyz789", + "company": "abc123", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "fax": "xyz789", + "firstname": "xyz789", + "id": 987, + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CartAddressRegion, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "abc123", + "vat_id": "abc123" } ``` -### AddRequisitionListItemToCartUserError +### CartAddressRegion -Contains details about why an attempt to add items to the requistion list failed. +Contains details about the region in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | -| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | - -#### Example +| `code` - [`String`](#string) | The state or province code. | +| `label` - [`String`](#string) | The display label for the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | + +#### Example ```json { - "message": "abc123", - "type": "OUT_OF_STOCK" + "code": "xyz789", + "label": "xyz789", + "region_id": 987 } ``` -### AddRequisitionListItemToCartUserErrorType +### CartDiscount -#### Values +Contains information about discounts applied to the cart. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `OUT_OF_STOCK` | | -| `UNAVAILABLE_SKU` | | -| `OPTIONS_UPDATED` | | -| `LOW_QUANTITY` | | +| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](#string) | The description of the discount. | #### Example ```json -""OUT_OF_STOCK"" +{ + "amount": Money, + "label": ["xyz789"] +} ``` -### AddRequisitionListItemsToCartOutput - -Output of the request to add items in a requisition list to the cart. +### CartDiscountType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | -| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | +| `ITEM` | | +| `SHIPPING` | | #### Example ```json -{ - "add_requisition_list_items_to_cart_user_errors": [ - AddRequisitionListItemToCartUserError - ], - "cart": Cart, - "status": true -} +""ITEM"" ``` -### AddReturnCommentInput - -Defines a return comment. +### CartItemError -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String!`](#string) | The text added to the return request. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | +| `message` - [`String!`](#string) | A localized error message | #### Example ```json -{ - "comment_text": "xyz789", - "return_uid": "4" -} +{"code": "UNDEFINED", "message": "xyz789"} ``` -### AddReturnCommentOutput - -Contains details about the return request. +### CartItemErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `UNDEFINED` | | +| `ITEM_QTY` | | +| `ITEM_INCREMENTS` | | #### Example ```json -{"return": Return} +""UNDEFINED"" ``` -### AddReturnTrackingInput +### CartItemInput -Defines tracking information to be added to the return. +Defines an item to be added to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | +| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | #### Example ```json { - "carrier_uid": "4", - "return_uid": 4, - "tracking_number": "abc123" + "entered_options": [EnteredOptionInput], + "parent_sku": "abc123", + "quantity": 123.45, + "selected_options": [4], + "sku": "abc123" } ``` -### AddReturnTrackingOutput +### CartItemInterface -Contains the response after adding tracking information. +An interface for products in a cart. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Possible Types + +| CartItemInterface Types | +|----------------| +| [`SimpleCartItem`](#simplecartitem) | +| [`VirtualCartItem`](#virtualcartitem) | +| [`ConfigurableCartItem`](#configurablecartitem) | +| [`BundleCartItem`](#bundlecartitem) | +| [`DownloadableCartItem`](#downloadablecartitem) | +| [`GiftCardCartItem`](#giftcardcartitem) | #### Example ```json { - "return": Return, - "return_shipping_tracking": ReturnShippingTracking + "discount": [Discount], + "errors": [CartItemError], + "id": "abc123", + "is_available": true, + "max_qty": 123.45, + "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 } ``` -### AddSimpleProductsToCartInput +### CartItemPrices -Defines the simple and group products to add to the cart. +Contains details about the price of the item, including taxes and discounts. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | +| Field Name | Description | +|------------|-------------| +| `catalog_discount` - [`ProductDiscount`](#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](#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!`](#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`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [SimpleProductCartItemInput] + "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 } ``` -### AddSimpleProductsToCartOutput +### CartItemQuantity -Contains details about the cart after adding simple or group products. +Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | #### Example ```json -{"cart": Cart} +{"cart_item_id": 987, "quantity": 123.45} ``` -### AddVirtualProductsToCartInput +### CartItemSelectedOptionValuePrice -Defines the virtual products to add to the cart. +Contains details about the price of a selected customizable value. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | +| Field Name | Description | +|------------|-------------| +| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](#float) | A price value. | #### Example ```json { - "cart_id": "abc123", - "cart_items": [VirtualProductCartItemInput] + "type": "FIXED", + "units": "abc123", + "value": 987.65 } ``` -### AddVirtualProductsToCartOutput +### CartItemUpdateInput -Contains details about the cart after adding virtual products. +A single item to be updated. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| Input Field | Description | +|-------------|-------------| +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | #### Example ```json -{"cart": Cart} +{ + "cart_item_id": 987, + "cart_item_uid": "4", + "customizable_options": [CustomizableOptionInput], + "gift_message": GiftMessageInput, + "gift_wrapping_id": "4", + "quantity": 123.45 +} ``` -### AddWishlistItemsToCartOutput - -Contains the resultant wish list and any error information. +### CartItems #### Fields | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned cart items. | #### Example ```json { - "add_wishlist_items_to_cart_user_errors": [ - WishlistCartUserInputError - ], - "status": true, - "wishlist": Wishlist + "items": [CartItemInterface], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### Aggregation +### CartPrices -Contains information for each filterable option (such as price, category `UID`, and custom attributes). +Contains details about the final price of items in the cart, including discount and tax information. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](#int) | The number of options in the aggregation group. | -| `label` - [`String`](#string) | The aggregation display name. | -| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | +| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | +| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | +| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | #### Example ```json { - "attribute_code": "xyz789", - "count": 123, - "label": "abc123", - "options": [AggregationOption], - "position": 123 + "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 } ``` -### AggregationOption - -An implementation of `AggregationOptionInterface`. +### CartRule #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | +| `name` - [`String!`](#string) | Name of the cart price rule | #### Example ```json -{ - "count": 123, - "label": "xyz789", - "value": "xyz789" -} +{"name": "abc123"} ``` -### AggregationOptionInterface +### CartTaxItem -Defines aggregation option fields. +Contains tax information about an item in the cart. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | - -#### Possible Types - -| AggregationOptionInterface Types | -|----------------| -| [`AggregationOption`](#aggregationoption) | +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `label` - [`String!`](#string) | The description of the tax. | #### Example ```json { - "count": 987, - "label": "abc123", - "value": "abc123" + "amount": Money, + "label": "abc123" } ``` -### AggregationsCategoryFilterInput - -Filter category aggregations in layered navigation. +### CartUserInputError -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json -{"includeDirectChildrenOnly": true} +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" +} ``` -### AggregationsFilterInput - -An input object that specifies the filters used in product aggregations. +### CartUserInputErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `COULD_NOT_FIND_CART_ITEM` | | +| `REQUIRED_PARAMETER_MISSING` | | +| `INVALID_PARAMETER_VALUE` | | +| `UNDEFINED` | | +| `PERMISSION_DENIED` | | #### Example ```json -{"category": AggregationsCategoryFilterInput} +""PRODUCT_NOT_FOUND"" ``` -### ApplePayConfig +### CatalogAttributeApplyToEnum -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "button_styles": ButtonStyles, - "code": "abc123", - "is_visible": true, - "payment_intent": "abc123", - "payment_source": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" -} -``` - - - -### ApplePayMethodInput - -Apple Pay inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "abc123" -} -``` - - - -### AppliedCoupon - -Contains the applied coupon code. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `SIMPLE` | | +| `VIRTUAL` | | +| `BUNDLE` | | +| `DOWNLOADABLE` | | +| `CONFIGURABLE` | | +| `GROUPED` | | +| `CATEGORY` | | #### Example ```json -{"code": "xyz789"} +""SIMPLE"" ``` -### AppliedGiftCard +### CatalogAttributeMetadata -Contains an applied gift card with applied and remaining balance. +Swatch attribute metadata. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | -| `code` - [`String`](#string) | The gift card account code. | -| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | +| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example ```json { - "applied_balance": Money, - "code": "abc123", - "current_balance": Money, - "expiration_date": "xyz789" + "apply_to": ["SIMPLE"], + "code": "4", + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "is_comparable": false, + "is_filterable": false, + "is_filterable_in_search": false, + "is_html_allowed_on_front": true, + "is_required": true, + "is_searchable": false, + "is_unique": true, + "is_used_for_price_rules": true, + "is_used_for_promo_rules": true, + "is_visible_in_advanced_search": true, + "is_visible_on_front": true, + "is_wysiwyg_enabled": false, + "label": "abc123", + "options": [CustomAttributeOptionInterface], + "swatch_input_type": "BOOLEAN", + "update_product_preview_image": true, + "use_product_image_for_swatch": true, + "used_in_product_listing": false } ``` -### AppliedStoreCredit - -Contains the applied and current balances. +### CatalogRule #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | +| `name` - [`String!`](#string) | Name of the catalog rule | #### Example ```json -{ - "applied_balance": Money, - "current_balance": Money, - "enabled": false -} +{"name": "xyz789"} ``` -### ApplyCouponToCartInput +### CategoryFilterInput -Specifies the coupon code to apply to the cart. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | #### Example ```json { - "cart_id": "abc123", - "coupon_code": "abc123" + "category_uid": FilterEqualTypeInput, + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput, + "parent_category_uid": FilterEqualTypeInput, + "parent_id": FilterEqualTypeInput, + "url_key": FilterEqualTypeInput, + "url_path": FilterEqualTypeInput } ``` -### ApplyCouponToCartOutput +### CategoryInterface -Contains details about the cart after applying a coupon. +Contains the full set of attributes that can be returned in a category search. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ApplyCouponsStrategy - -The strategy to apply coupons to the cart. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""APPEND"" -``` - - - -### ApplyCouponsToCartInput - -Apply coupons to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | -| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | - -#### Example - -```json -{ - "cart_id": "abc123", - "coupon_codes": ["abc123"], - "type": "APPEND" -} -``` - - - -### ApplyGiftCardToCartInput - -Defines the input required to run the `applyGiftCardToCart` mutation. +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | +| CategoryInterface Types | +|----------------| +| [`CategoryTree`](#categorytree) | #### Example ```json { - "cart_id": "abc123", - "gift_card_code": "abc123" + "automatic_sorting": "abc123", + "available_sort_by": ["abc123"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "abc123", + "children_count": "abc123", + "cms_block": CmsBlock, + "created_at": "abc123", + "custom_layout_update_file": "xyz789", + "default_sort_by": "abc123", + "description": "abc123", + "display_mode": "xyz789", + "filter_price_range": 123.45, + "id": 123, + "image": "xyz789", + "include_in_menu": 987, + "is_anchor": 987, + "landing_page": 123, + "level": 987, + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "xyz789", + "name": "abc123", + "path": "xyz789", + "path_in_store": "abc123", + "position": 987, + "product_count": 987, + "products": CategoryProducts, + "staged": false, + "uid": 4, + "updated_at": "xyz789", + "url_key": "xyz789", + "url_path": "abc123", + "url_suffix": "abc123" } ``` -### ApplyGiftCardToCartOutput +### CategoryProducts -Defines the possible output for the `applyGiftCardToCart` mutation. +Contains details about the products assigned to a category. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#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 ```json -{"cart": Cart} +{ + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### ApplyGiftCardToOrder +### CategoryResult -Contains applied gift cards with gift card code and amount. +Contains a collection of `CategoryTree` objects and pagination information. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](#string) | The gift card account code. | +| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | #### Example ```json { - "applied_balance": Money, - "code": "abc123" + "items": [CategoryTree], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### ApplyRewardPointsToCartOutput +### CategoryTree -Contains the customer cart. +Contains the hierarchy of categories. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ApplyStoreCreditToCartInput - -Defines the input required to run the `applyStoreCreditToCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### ApplyStoreCreditToCartOutput - -Defines the possible output for the `applyStoreCreditToCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | +| `children_count` - [`String`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | #### Example ```json -{"cart": Cart} +{ + "automatic_sorting": "xyz789", + "available_sort_by": ["abc123"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "abc123", + "children": [CategoryTree], + "children_count": "abc123", + "cms_block": CmsBlock, + "created_at": "xyz789", + "custom_layout_update_file": "abc123", + "default_sort_by": "xyz789", + "description": "abc123", + "display_mode": "abc123", + "filter_price_range": 123.45, + "id": 987, + "image": "abc123", + "include_in_menu": 987, + "is_anchor": 123, + "landing_page": 987, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "abc123", + "meta_title": "abc123", + "name": "abc123", + "path": "abc123", + "path_in_store": "abc123", + "position": 123, + "product_count": 123, + "products": CategoryProducts, + "redirect_code": 123, + "relative_url": "xyz789", + "staged": true, + "type": "CMS_PAGE", + "uid": 4, + "updated_at": "abc123", + "url_key": "xyz789", + "url_path": "abc123", + "url_suffix": "xyz789" +} ``` -### AreaInput +### CheckoutAgreement -AreaInput defines the parameters which will be used for filter by specified location. +Defines details about an individual checkout agreement. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `radius` - [`Int!`](#int) | The radius for the search in KM. | -| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| Field Name | Description | +|------------|-------------| +| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](#string) | Required. The text of the agreement. | +| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | +| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | +| `name` - [`String!`](#string) | The name given to the condition. | #### Example ```json -{"radius": 987, "search_term": "xyz789"} +{ + "agreement_id": 987, + "checkbox_text": "xyz789", + "content": "xyz789", + "content_height": "xyz789", + "is_html": true, + "mode": "AUTO", + "name": "abc123" +} ``` -### AssignCompareListToCustomerOutput +### CheckoutAgreementMode -Contains the results of the request to assign a compare list. +Indicates how agreements are accepted. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | +| `AUTO` | Conditions are automatically accepted upon checkout. | +| `MANUAL` | Shoppers must manually accept the conditions to place an order. | #### Example ```json -{"compare_list": CompareList, "result": true} +""AUTO"" ``` -### Attribute +### CheckoutUserInputError -Contains details about the attribute, including the code and type. +An error encountered while adding an item to the cart. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | -| `attribute_type` - [`String`](#string) | The data type of the attribute. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | +| `message` - [`String!`](#string) | A localized error message. | +| `path` - [`[String]!`](#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 ```json { - "attribute_code": "abc123", - "attribute_options": [AttributeOption], - "attribute_type": "xyz789", - "entity_type": "abc123", - "input_type": "xyz789", - "storefront_properties": StorefrontProperties + "code": "REORDER_NOT_AVAILABLE", + "message": "xyz789", + "path": ["xyz789"] } ``` -### AttributeEntityTypeEnum - -List of all entity types. Populated by the modules introducing EAV entities. +### CheckoutUserInputErrorCodes #### Values | Enum Value | Description | |------------|-------------| -| `CATALOG_PRODUCT` | | -| `CATALOG_CATEGORY` | | -| `CUSTOMER` | | -| `CUSTOMER_ADDRESS` | | -| `RMA_ITEM` | | +| `REORDER_NOT_AVAILABLE` | | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | #### Example ```json -""CATALOG_PRODUCT"" +""REORDER_NOT_AVAILABLE"" ``` -### AttributeFilterInput +### ClearCartError -An input object that specifies the filters used for attributes. +Contains details about errors encountered when a customer clear cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | A localized error message | +| `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{ - "is_comparable": false, - "is_filterable": false, - "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": true, - "is_used_for_promo_rules": false, - "is_visible_in_advanced_search": false, - "is_visible_on_front": true, - "is_wysiwyg_enabled": false, - "used_in_product_listing": false -} +{"message": "abc123", "type": "NOT_FOUND"} ``` -### AttributeFrontendInputEnum - -EAV attribute frontend input types. +### ClearCartErrorType #### Values | Enum Value | Description | |------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `WEIGHT` | | +| `NOT_FOUND` | | +| `UNAUTHORISED` | | +| `INACTIVE` | | | `UNDEFINED` | | #### Example ```json -""BOOLEAN"" -``` - - - -### AttributeInput - -Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "entity_type": "abc123" -} +""NOT_FOUND"" ``` -### AttributeInputSelectedOption +### ClearCartInput -Specifies selected option for a select or multiselect attribute value. +Assigns a specific `cart_id` to the empty cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | #### Example ```json -{"value": "abc123"} +{"uid": "4"} ``` -### AttributeMetadata +### ClearCartOutput -Base EAV implementation of CustomAttributeMetadataInterface. +Output of the request to clear the customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `cart` - [`Cart`](#cart) | The cart after clear cart items. | +| `errors` - [`[ClearCartError]`](#clearcarterror) | An array of errors encountered while clearing the cart item | #### Example ```json { - "code": 4, - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": false, - "label": "xyz789", - "options": [CustomAttributeOptionInterface] + "cart": Cart, + "errors": [ClearCartError] } ``` -### AttributeMetadataError +### ClearCustomerCartOutput -Attribute metadata retrieval error. +Output of the request to clear the customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | -| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | +| `cart` - [`Cart`](#cart) | The cart after clearing items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | #### Example ```json -{ - "message": "xyz789", - "type": "ENTITY_NOT_FOUND" -} +{"cart": Cart, "status": false} ``` -### AttributeMetadataErrorType - -Attribute metadata retrieval error types. +### CloseNegotiableQuoteError -#### Values +#### Types -| Enum Value | Description | -|------------|-------------| -| `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. | +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | #### Example ```json -""ENTITY_NOT_FOUND"" +NegotiableQuoteInvalidStateError ``` -### AttributeOption +### CloseNegotiableQuoteOperationFailure -Defines an attribute option. +Contains details about a failed close operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "label": "abc123", - "value": "xyz789" + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": 4 } ``` -### AttributeOptionMetadata - -Base EAV implementation of CustomAttributeOptionInterface. +### CloseNegotiableQuoteOperationResult -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example ```json -{ - "is_default": false, - "label": "abc123", - "value": "abc123" -} +NegotiableQuoteUidOperationSuccess ``` -### AttributeSelectedOption +### CloseNegotiableQuotesInput -#### Fields +Defines the negotiable quotes to mark as closed. -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +#### Input Fields -#### Example +| Input Field | Description | +|-------------|-------------| +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | + +#### Example ```json -{ - "label": "xyz789", - "value": "xyz789" -} +{"quote_uids": ["4"]} ``` -### AttributeSelectedOptionInterface +### CloseNegotiableQuotesOutput + +Contains the closed negotiable quotes and other negotiable quotes the company user can view. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | - -#### Possible Types - -| AttributeSelectedOptionInterface Types | -|----------------| -| [`AttributeSelectedOption`](#attributeselectedoption) | +| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example ```json { - "label": "xyz789", - "value": "abc123" + "closed_quotes": [NegotiableQuote], + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" } ``` -### AttributeSelectedOptions +### CmsBlock + +Contains details about a specific CMS block. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | +| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](#string) | The CMS block identifier. | +| `title` - [`String`](#string) | The title assigned to the CMS block. | #### Example ```json { - "code": "4", - "selected_options": [AttributeSelectedOptionInterface] + "content": "xyz789", + "identifier": "abc123", + "title": "abc123" } ``` -### AttributeValue +### CmsBlocks + +Contains an array CMS block items. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | #### Example ```json -{"code": 4, "value": "abc123"} +{"items": [CmsBlock]} ``` -### AttributeValueInput +### CmsPage -Specifies the value for attribute. +Contains details about a CMS page. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | -| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](#string) | The value assigned to the attribute. | +| Field Name | Description | +|------------|-------------| +| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](#string) | The ID of a CMS page. | +| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { - "attribute_code": "xyz789", - "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "content": "xyz789", + "content_heading": "abc123", + "identifier": "abc123", + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "page_layout": "xyz789", + "redirect_code": 987, + "relative_url": "xyz789", + "title": "abc123", + "type": "CMS_PAGE", + "url_key": "abc123" } ``` -### AttributeValueInterface +### ColorSwatchData #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | - -#### Possible Types - -| AttributeValueInterface Types | -|----------------| -| [`AttributeValue`](#attributevalue) | -| [`AttributeSelectedOptions`](#attributeselectedoptions) | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"code": "4"} +{"value": "xyz789"} ``` -### AttributesFormOutput +### CompaniesSortFieldEnum -Metadata of EAV attributes associated to form +The fields available for sorting the customer companies. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `NAME` | The name of the company. | #### Example ```json -{ - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] -} +""NAME"" ``` -### AttributesMetadataOutput +### CompaniesSortInput -Metadata of EAV attributes. +Specifies which field to sort on, and whether to return the results in ascending or descending order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| Input Field | Description | +|-------------|-------------| +| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | +| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example ```json -{ - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] -} +{"field": "NAME", "order": "ASC"} ``` -### AvailableCurrency +### Company -Defines the code and symbol of a currency that can be used for purchase orders. +Contains the output schema for a company. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | +| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | +| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | +| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | +| `email` - [`String`](#string) | The email address of the company contact. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | +| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | +| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | +| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | +| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | +| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | +| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{ + "acl_resources": [CompanyAclResource], + "company_admin": Customer, + "credit": CompanyCredit, + "credit_history": CompanyCreditHistory, + "email": "xyz789", + "id": "4", + "legal_address": CompanyLegalAddress, + "legal_name": "xyz789", + "name": "xyz789", + "payment_methods": ["xyz789"], + "reseller_id": "abc123", + "role": CompanyRole, + "roles": CompanyRoles, + "sales_representative": CompanySalesRepresentative, + "structure": CompanyStructure, + "team": CompanyTeam, + "user": Customer, + "users": CompanyUsers, + "vat_tax_id": "xyz789" +} ``` -### AvailablePaymentMethod +### CompanyAclResource -Describes a payment method that the shopper can use to pay for the order. +Contains details about the access control list settings of a resource. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | +| `text` - [`String`](#string) | The label assigned to the ACL resource. | #### Example ```json { - "code": "xyz789", - "is_deferred": false, - "title": "xyz789" + "children": [CompanyAclResource], + "id": "4", + "sort_order": 987, + "text": "abc123" } ``` -### AvailableShippingMethod +### CompanyAdminInput -Contains details about the possible shipping methods and carriers. +Defines the input schema for creating a company administrator. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `error_message` - [`String`](#string) | Describes an error condition. | -| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| Input Field | Description | +|-------------|-------------| +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](#string) | The email address of the company administrator. | +| `firstname` - [`String!`](#string) | The company administrator's first name. | +| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](#string) | The job title of the company administrator. | +| `lastname` - [`String!`](#string) | The company administrator's last name. | +| `telephone` - [`String`](#string) | The phone number of the company administrator. | #### Example ```json { - "amount": Money, - "available": true, - "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", - "error_message": "xyz789", - "method_code": "abc123", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money + "custom_attributes": [AttributeValueInput], + "email": "abc123", + "firstname": "abc123", + "gender": 123, + "job_title": "abc123", + "lastname": "xyz789", + "telephone": "abc123" } ``` -### BatchMutationStatus +### CompanyBasicInfo -#### Values +The minimal required information to identify and display the company. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `SUCCESS` | | -| `FAILURE` | | -| `MIXED_RESULTS` | | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | #### Example ```json -""SUCCESS"" +{ + "id": 4, + "legal_name": "xyz789", + "name": "xyz789" +} ``` -### BillingAddressInput +### CompanyCreateInput -Defines the billing address. +Defines the input schema for creating a new company. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | -| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | +| `company_email` - [`String!`](#string) | The email address of the company contact. | +| `company_name` - [`String!`](#string) | The name of the company to create. | +| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "address": CartAddressInput, - "customer_address_id": 123, - "same_as_shipping": true, - "use_for_shipping": false + "company_admin": CompanyAdminInput, + "company_email": "xyz789", + "company_name": "xyz789", + "legal_address": CompanyLegalAddressCreateInput, + "legal_name": "xyz789", + "reseller_id": "xyz789", + "vat_tax_id": "xyz789" } ``` -### BillingAddressPaymentSourceInput +### CompanyCredit -The billing address information +Contains company credit balances and limits. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address_line_1` - [`String`](#string) | The first line of the address | -| `address_line_2` - [`String`](#string) | The second line of the address | -| `city` - [`String`](#string) | The city of the address | -| `country_code` - [`String!`](#string) | The country of the address | -| `postal_code` - [`String`](#string) | The postal code of the address | -| `region` - [`String`](#string) | The region of the address | +| Field Name | Description | +|------------|-------------| +| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](#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 ```json { - "address_line_1": "abc123", - "address_line_2": "abc123", - "city": "xyz789", - "country_code": "xyz789", - "postal_code": "xyz789", - "region": "xyz789" + "available_credit": Money, + "credit_limit": Money, + "outstanding_balance": Money } ``` -### BillingCartAddress +### CompanyCreditHistory -Contains details about the billing address. +Contains details about prior company credit operations. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | #### Example ```json { - "city": "abc123", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_notes": "abc123", - "fax": "abc123", - "firstname": "xyz789", - "id": 123, - "lastname": "abc123", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", - "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": "xyz789", - "vat_id": "abc123" + "items": [CompanyCreditOperation], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### Boolean +### CompanyCreditHistoryFilterInput -The `Boolean` scalar type represents `true` or `false`. +Defines a filter for narrowing the results of a credit history search. -#### Example - -```json -true -``` - - - -### BraintreeCcVaultInput - -#### Input Fields +#### Input Fields | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "device_data": "xyz789", - "public_hash": "abc123" + "custom_reference_number": "abc123", + "operation_type": "ALLOCATION", + "updated_by": "xyz789" } ``` -### BraintreeInput +### CompanyCreditOperation -#### Input Fields +Contains details about a single company credit operation. -| Input Field | Description | -|-------------|-------------| -| `device_data` - [`String`](#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!`](#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!`](#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](#string) | The date the operation occurred. | +| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | #### Example ```json { - "device_data": "abc123", - "is_active_payment_token_enabler": false, - "payment_method_nonce": "xyz789" + "amount": Money, + "balance": CompanyCredit, + "custom_reference_number": "abc123", + "date": "abc123", + "type": "ALLOCATION", + "updated_by": CompanyCreditOperationUser } ``` -### BraintreeVaultInput +### CompanyCreditOperationType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| Enum Value | Description | +|------------|-------------| +| `ALLOCATION` | | +| `UPDATE` | | +| `PURCHASE` | | +| `REIMBURSEMENT` | | +| `REFUND` | | +| `REVERT` | | #### Example ```json -{ - "device_data": "abc123", - "public_hash": "abc123" -} +""ALLOCATION"" ``` -### Breadcrumb +### CompanyCreditOperationUser -Contains details about an individual category that comprises a breadcrumb. +Defines the administrator or company user that submitted a company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](#int) | The category level. | -| `category_name` - [`String`](#string) | The display name of the category. | -| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](#string) | The URL key of the category. | -| `category_url_path` - [`String`](#string) | The URL path of the category. | +| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | #### Example ```json -{ - "category_id": 123, - "category_level": 987, - "category_name": "xyz789", - "category_uid": 4, - "category_url_key": "abc123", - "category_url_path": "xyz789" -} +{"name": "xyz789", "type": "CUSTOMER"} ``` -### BundleCartItem - -An implementation for bundle product cart items. +### CompanyCreditOperationUserType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `CUSTOMER` | | +| `ADMIN` | | #### Example ```json -{ - "available_gift_wrapping": [GiftWrapping], - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "abc123", - "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": 123.45, - "uid": "4" -} +""CUSTOMER"" ``` -### BundleCreditMemoItem +### CompanyInvitationInput -Defines bundle product options for `CreditMemoItemInterface`. +Defines the input schema for accepting the company invitation. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| Input Field | Description | +|-------------|-------------| +| `code` - [`String!`](#string) | The invitation code. | +| `role_id` - [`ID`](#id) | The company role id. | +| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "code": "xyz789", + "role_id": 4, + "user": CompanyInvitationUserInput } ``` -### BundleInvoiceItem +### CompanyInvitationOutput -Defines bundle product options for `InvoiceItemInterface`. +The result of accepting the company invitation. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | + +#### Example + +```json +{"success": true} +``` + + + +### CompanyInvitationUserInput + +Company user attributes in the invitation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `company_id` - [`ID!`](#id) | The company unique identifier. | +| `customer_id` - [`ID!`](#id) | The customer unique identifier. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The phone number of the company user. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 + "company_id": "4", + "customer_id": "4", + "job_title": "xyz789", + "status": "ACTIVE", + "telephone": "abc123" } ``` -### BundleItem +### CompanyLegalAddress -Defines an individual item within a bundle product. +Contains details about the address where the company is registered to conduct business. #### Fields | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | -| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | -| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](#string) | The SKU of the bundle product. | -| `title` - [`String`](#string) | The display name of the item. | -| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | +| `postcode` - [`String`](#string) | The company's postal code. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | +| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](#string) | The company's phone number. | #### Example ```json { - "option_id": 123, - "options": [BundleItemOption], - "position": 987, - "price_range": PriceRange, - "required": false, - "sku": "abc123", - "title": "xyz789", - "type": "xyz789", - "uid": 4 + "city": "abc123", + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegion, + "street": ["xyz789"], + "telephone": "abc123" } ``` -### BundleItemOption +### CompanyLegalAddressCreateInput -Defines the characteristics that comprise a specific bundle item and its options. +Defines the input schema for defining a company's legal address. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | -| `label` - [`String`](#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | +| `postcode` - [`String!`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](#string) | The primary phone number of the company. | #### Example ```json { - "can_change_quantity": true, - "id": 987, - "is_default": true, - "label": "abc123", - "position": 987, - "price": 123.45, - "price_type": "FIXED", - "product": ProductInterface, - "qty": 123.45, - "quantity": 123.45, - "uid": "4" + "city": "abc123", + "country_id": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "telephone": "abc123" } ``` -### BundleOptionInput +### CompanyLegalAddressUpdateInput -Defines the input for a bundle option. +Defines the input schema for updating a company's legal address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](#int) | The ID of the option. | -| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | +| `postcode` - [`String`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](#string) | The primary phone number of the company. | #### Example ```json { - "id": 987, - "quantity": 123.45, - "value": ["xyz789"] + "city": "xyz789", + "country_id": "AF", + "postcode": "abc123", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "telephone": "abc123" } ``` -### BundleOrderItem +### CompanyRole -Defines bundle product options for `OrderItemInterface`. +Contails details about a single role. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name assigned to the role. | +| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | +| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "abc123", - "prices": OrderItemPrices, - "product": ProductInterface, - "product_name": "xyz789", - "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": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "abc123" + "name": "abc123", + "permissions": [CompanyAclResource], + "users_count": 987 } ``` -### BundleProduct +### CompanyRoleCreateInput -Defines basic features of a bundle product and contains multiple BundleItems. +Defines the input schema for creating a company role. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | -| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | -| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the role to create. | +| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | #### Example ```json { - "activity": "abc123", - "attribute_set_id": 987, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "abc123", - "collar": "abc123", - "color": 987, - "country_of_manufacture": "abc123", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "dynamic_price": false, - "dynamic_sku": true, - "dynamic_weight": false, - "eco_collection": 987, - "erin_recommends": 987, - "features_bags": "abc123", - "format": 123, - "gender": "abc123", - "gift_message_available": false, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "items": [BundleItem], - "manufacturer": 123, - "material": "abc123", - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, "name": "abc123", - "new": 123, - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "pattern": "abc123", - "performance_fabric": 123, - "price": ProductPrices, - "price_details": PriceDetails, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "price_view": "PRICE_RANGE", - "product_links": [ProductLinksInterface], - "purpose": 987, - "quantity": 987.65, - "rating_summary": 987.65, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, - "reviews": ProductReviews, - "rules": [CatalogRule], - "sale": 987, - "ship_bundle_items": "TOGETHER", - "short_description": ComplexTextValue, - "size": 987, - "sku": "abc123", - "sleeve": "abc123", - "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": "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": "xyz789", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website], - "weight": 123.45 + "permissions": ["abc123"] } ``` -### BundleProductCartItemInput +### CompanyRoleUpdateInput -Defines a single bundle product. +Defines the input schema for updating a company role. #### Input Fields | Input Field | Description | |-------------|-------------| -| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name of the role to update. | +| `permissions` - [`[String]`](#string) | A list of resources the role can access. | #### Example ```json { - "bundle_options": [BundleOptionInput], - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput + "id": "4", + "name": "abc123", + "permissions": ["xyz789"] } ``` -### BundleRequisitionListItem +### CompanyRoles -Contains details about bundle products added to a requisition list. +Contains an array of roles. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | #### Example ```json { - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "items": [CompanyRole], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### BundleShipmentItem +### CompanySalesRepresentative -Defines bundle product options for `ShipmentItemInterface`. +Contains details about a company sales representative. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| `email` - [`String`](#string) | The email address of the company sales representative. | +| `firstname` - [`String`](#string) | The company sales representative's first name. | +| `lastname` - [`String`](#string) | The company sales representative's last name. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 + "email": "xyz789", + "firstname": "abc123", + "lastname": "xyz789" } ``` -### BundleWishlistItem +### CompanyStructure -Defines bundle product options for `WishlistItemInterface`. +Contains an array of the individual nodes that comprise the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | #### Example ```json -{ - "added_at": "xyz789", - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "product": ProductInterface, - "quantity": 123.45 -} +{"items": [CompanyStructureItem]} +``` + + + +### CompanyStructureEntity + +#### Types + +| Union Types | +|-------------| +| [`CompanyTeam`](#companyteam) | +| [`Customer`](#customer) | + +#### Example + +```json +CompanyTeam ``` -### ButtonStyles +### CompanyStructureItem + +Defines an individual node in the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `label` - [`String`](#string) | The button label | -| `layout` - [`String`](#string) | The button layout | -| `shape` - [`String`](#string) | The button shape | -| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | -| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | +| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | #### Example ```json { - "color": "xyz789", - "height": 987, - "label": "xyz789", - "layout": "xyz789", - "shape": "abc123", - "tagline": true, - "use_default_height": false + "entity": CompanyTeam, + "id": 4, + "parent_id": "4" } ``` -### CancelNegotiableQuoteTemplateInput +### CompanyStructureUpdateInput -Specifies the quote template id of the quote template to cancel +Defines the input schema for updating the company structure. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{ - "cancellation_comment": "xyz789", - "template_id": "4" -} +{"parent_tree_id": 4, "tree_id": 4} ``` -### CancelOrderError +### CompanyTeam + +Describes a company team. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](#string) | A localized error message. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](#string) | The display name of the team. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | #### Example ```json { - "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "description": "xyz789", + "id": 4, + "name": "abc123", + "structure_id": "4" } ``` -### CancelOrderErrorCode +### CompanyTeamCreateInput -#### Values +Defines the input schema for creating a company team. -| Enum Value | Description | -|------------|-------------| -| `ORDER_CANCELLATION_DISABLED` | | -| `UNDEFINED` | | -| `UNAUTHORISED` | | -| `ORDER_NOT_FOUND` | | -| `PARTIAL_ORDER_ITEM_SHIPPED` | | -| `INVALID_ORDER_STATUS` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `name` - [`String!`](#string) | The display name of the team. | +| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json -""ORDER_CANCELLATION_DISABLED"" +{ + "description": "abc123", + "name": "abc123", + "target_id": 4 +} ``` -### CancelOrderInput +### CompanyTeamUpdateInput -Defines the order to cancel. +Defines the input schema for updating a company team. #### Input Fields | Input Field | Description | |-------------|-------------| -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](#string) | The display name of the team. | #### Example ```json { - "order_id": "4", - "reason": "abc123" + "description": "abc123", + "id": "4", + "name": "abc123" } ``` -### CancelOrderOutput +### CompanyUpdateInput -Contains the updated customer order and error message if any. +Defines the input schema for updating a company. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | -| `errorV2` - [`CancelOrderError`](#cancelordererror) | | -| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | +| Input Field | Description | +|-------------|-------------| +| `company_email` - [`String`](#string) | The email address of the company contact. | +| `company_name` - [`String`](#string) | The name of the company to update. | +| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "error": "xyz789", - "errorV2": CancelOrderError, - "order": CustomerOrder + "company_email": "abc123", + "company_name": "abc123", + "legal_address": CompanyLegalAddressUpdateInput, + "legal_name": "abc123", + "reseller_id": "abc123", + "vat_tax_id": "xyz789" } ``` -### CancellationReason +### CompanyUserCreateInput -#### Fields +Defines the input schema for creating a company user. -| Field Name | Description | -|------------|-------------| -| `description` - [`String!`](#string) | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The company user's email address | +| `firstname` - [`String!`](#string) | The company user's first name. | +| `job_title` - [`String!`](#string) | The company user's job title or function. | +| `lastname` - [`String!`](#string) | The company user's last name. | +| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `target_id` - [`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!`](#string) | The company user's phone number. | #### Example ```json -{"description": "abc123"} +{ + "email": "abc123", + "firstname": "abc123", + "job_title": "xyz789", + "lastname": "abc123", + "role_id": 4, + "status": "ACTIVE", + "target_id": "4", + "telephone": "abc123" +} ``` -### Card +### CompanyUserStatusEnum -#### Fields +Defines the list of company user status values. -| Field Name | Description | +#### Values + +| Enum Value | Description | |------------|-------------| -| `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](#string) | Expiration year of the card | -| `last_digits` - [`String`](#string) | Last four digits of the card | -| `name` - [`String`](#string) | Name on the card | +| `ACTIVE` | Only active users. | +| `INACTIVE` | Only inactive users. | + +#### Example + +```json +""ACTIVE"" +``` + + + +### CompanyUserUpdateInput + +Defines the input schema for updating a company user. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String`](#string) | The company user's email address. | +| `firstname` - [`String`](#string) | The company user's first name. | +| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](#string) | The company user's job title or function. | +| `lastname` - [`String`](#string) | The company user's last name. | +| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The company user's phone number. | #### Example ```json { - "bin_details": CardBin, - "card_expiry_month": "abc123", - "card_expiry_year": "xyz789", - "last_digits": "abc123", - "name": "abc123" + "email": "xyz789", + "firstname": "abc123", + "id": 4, + "job_title": "abc123", + "lastname": "xyz789", + "role_id": "4", + "status": "ACTIVE", + "telephone": "abc123" } ``` -### CardBin +### CompanyUsers + +Contains details about company users. #### Fields | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The number of objects returned. | #### Example ```json -{"bin": "abc123"} +{ + "items": [Customer], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### CardPaymentSourceInput +### CompanyUsersFilterInput -The card payment source information +Defines the filter for returning a list of company users. #### Input Fields | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](#string) | The name on the cardholder | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | #### Example ```json -{ - "billing_address": BillingAddressPaymentSourceInput, - "name": "abc123" -} +{"status": "ACTIVE"} ``` -### CardPaymentSourceOutput +### ComparableAttribute -The card payment source information +Contains an attribute code that is used for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `brand` - [`String`](#string) | The brand of the card | -| `expiry` - [`String`](#string) | The expiry of the card | -| `last_digits` - [`String`](#string) | The last digits of the card | +| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](#string) | The label of the attribute code. | #### Example ```json { - "brand": "abc123", - "expiry": "abc123", - "last_digits": "xyz789" + "code": "abc123", + "label": "abc123" } ``` -### Cart +### ComparableItem -Contains the contents and other details about a guest or customer cart. +Defines an object used to iterate through items for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. *(Deprecated: Use `itemsV2` instead.)* | -| `itemsV2` - [`CartItems`](#cartitems) | | -| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `rules` - [`[CartRule]`](#cartrule) | Provides applied cart rules in the current active cart | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | +| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | #### Example ```json { - "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": [CartRule], - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "attributes": [ProductAttribute], + "product": ProductInterface, + "uid": 4 } ``` -### CartAddressCountry +### CompareList -Contains details the country in a billing or shipping address. +Contains iterable information such as the array of items, the count, and attributes that represent the compare list. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | +| `item_count` - [`Int!`](#int) | The number of items in the compare list. | +| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | #### Example ```json { - "code": "abc123", - "label": "abc123" + "attributes": [ComparableAttribute], + "item_count": 987, + "items": [ComparableItem], + "uid": 4 } ``` -### CartAddressInput - -Defines the billing or shipping address to be applied to the cart. +### ComplexTextValue -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| Field Name | Description | +|------------|-------------| +| `html` - [`String!`](#string) | Text that can contain HTML tags. | #### Example ```json -{ - "city": "abc123", - "company": "abc123", - "country_code": "abc123", - "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": "abc123", - "region_id": 987, - "save_in_address_book": false, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "xyz789" -} -``` - - - -### CartAddressInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | - -#### Possible Types - -| CartAddressInterface Types | -|----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | - -#### Example - -```json -{ - "city": "abc123", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "fax": "xyz789", - "firstname": "xyz789", - "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", - "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": "xyz789", - "vat_id": "xyz789" -} +{"html": "abc123"} ``` -### CartAddressRegion +### ConfigurableAttributeOption -Contains details about the region in a billing or shipping address. +Contains details about a configurable product attribute option. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The state or province code. | -| `label` - [`String`](#string) | The display label for the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `code` - [`String`](#string) | The ID assigned to the attribute. | +| `label` - [`String`](#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "code": "xyz789", + "code": "abc123", "label": "xyz789", - "region_id": 123 -} -``` - - - -### CartDiscount - -Contains information about discounts applied to the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | - -#### Example - -```json -{ - "amount": Money, - "label": ["xyz789"] -} -``` - - - -### CartDiscountType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ITEM` | | -| `SHIPPING` | | - -#### Example - -```json -""ITEM"" -``` - - - -### CartItemError - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | - -#### Example - -```json -{"code": "UNDEFINED", "message": "xyz789"} -``` - - - -### CartItemErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `ITEM_QTY` | | -| `ITEM_INCREMENTS` | | - -#### Example - -```json -""UNDEFINED"" -``` - - - -### CartItemInput - -Defines an item to be added to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 987.65, - "selected_options": [4], - "sku": "xyz789" + "uid": "4", + "value_index": 987 } ``` -### CartItemInterface +### ConfigurableCartItem -An interface for products in a cart. +An implementation for configurable product cart items. #### Fields | Field Name | Description | |------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | | `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | | `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | | `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Possible Types - -| CartItemInterface Types | -|----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | -| [`ConfigurableCartItem`](#configurablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`DownloadableCartItem`](#downloadablecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { + "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": 123.45, + "is_available": false, + "max_qty": 987.65, "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], @@ -3070,3723 +2727,4884 @@ An interface for products in a cart. -### CartItemPrices +### ConfigurableOptionAvailableForSelection -Contains details about the price of the item, including taxes and discounts. +Describes configurable options that have been selected and can be selected as a result of the previous selections. #### Fields | Field Name | Description | |------------|-------------| -| `catalog_discount` - [`ProductDiscount`](#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | -| `original_item_price` - [`Money!`](#money) | The value of the original unit price for the item, including discounts. | -| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | -| `price` - [`Money!`](#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!`](#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`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | #### Example ```json { - "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 + "attribute_code": "abc123", + "option_value_uids": [4] } ``` -### CartItemQuantity - -Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. +### ConfigurableOrderItem #### Fields | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | - -#### Example - -```json -{"cart_item_id": 987, "quantity": 123.45} -``` - - - -### CartItemSelectedOptionValuePrice - -Contains details about the price of a selected customizable value. +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "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": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} +``` + + + +### ConfigurableProduct + +Defines basic features of a configurable product and its simple product variants. #### Fields | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](#float) | A price value. | +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | +| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "type": "FIXED", - "units": "xyz789", - "value": 987.65 + "activity": "abc123", + "attribute_set_id": 123, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "abc123", + "collar": "abc123", + "color": 987, + "configurable_options": [ConfigurableProductOptions], + "configurable_product_options_selection": ConfigurableProductOptionsSelection, + "country_of_manufacture": "abc123", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "eco_collection": 987, + "erin_recommends": 123, + "features_bags": "abc123", + "format": 987, + "gender": "xyz789", + "gift_message_available": true, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 987, + "material": "xyz789", + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "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": "abc123", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 123, + "quantity": 987.65, + "rating_summary": 987.65, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 123, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 123, + "short_description": ComplexTextValue, + "size": 123, + "sku": "xyz789", + "sleeve": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "strap_bags": "abc123", + "style_bags": "xyz789", + "style_bottom": "xyz789", + "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": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "variants": [ConfigurableVariant], + "websites": [Website], + "weight": 987.65 } ``` -### CartItemUpdateInput - -A single item to be updated. +### ConfigurableProductCartItemInput #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | +| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](#string) | | #### Example ```json { - "cart_item_id": 123, - "cart_item_uid": 4, "customizable_options": [CustomizableOptionInput], - "gift_message": GiftMessageInput, - "gift_wrapping_id": "4", - "quantity": 987.65 + "data": CartItemInput, + "parent_sku": "xyz789", + "variant_sku": "xyz789" } ``` -### CartItems +### ConfigurableProductOption + +Contains details about configurable product options. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned cart items. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](#string) | The display name of the option. | +| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | +| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example ```json { - "items": [CartItemInterface], - "page_info": SearchResultPageInfo, - "total_count": 987 + "attribute_code": "xyz789", + "label": "abc123", + "uid": 4, + "values": [ConfigurableProductOptionValue] } ``` -### CartPrices +### ConfigurableProductOptionValue -Contains details about the final price of items in the cart, including discount and tax information. +Defines a value for a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | -| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | -| `grand_total_excluding_tax` - [`Money`](#money) | The total of the cart, including discounts, shipping, and other fees without tax. | -| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | +| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](#id) | The unique ID of the value. | #### Example ```json { - "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 + "is_available": true, + "is_use_default": true, + "label": "xyz789", + "swatch": SwatchDataInterface, + "uid": 4 } ``` -### CartRule +### ConfigurableProductOptions + +Defines configurable attributes for the specified product. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | Name of the cart price rule | +| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | +| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | #### Example ```json -{"name": "xyz789"} +{ + "attribute_code": "xyz789", + "attribute_id": "abc123", + "attribute_id_v2": 987, + "attribute_uid": 4, + "id": 987, + "label": "xyz789", + "position": 123, + "product_id": 987, + "uid": "4", + "use_default": true, + "values": [ConfigurableProductOptionsValues] +} ``` -### CartTaxItem +### ConfigurableProductOptionsSelection -Contains tax information about an item in the cart. +Contains metadata corresponding to the selected configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | +| `variant` - [`SimpleProduct`](#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 ```json { - "amount": Money, - "label": "abc123" + "configurable_options": [ConfigurableProductOption], + "media_gallery": [MediaGalleryInterface], + "options_available_for_selection": [ + ConfigurableOptionAvailableForSelection + ], + "variant": SimpleProduct } ``` -### CartUserInputError +### ConfigurableProductOptionsValues + +Contains the index number assigned to a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `default_label` - [`String`](#string) | The label of the product on the default store. | +| `label` - [`String`](#string) | The label of the product. | +| `store_label` - [`String`](#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "default_label": "abc123", + "label": "xyz789", + "store_label": "abc123", + "swatch_data": SwatchDataInterface, + "uid": "4", + "use_default_value": false, + "value_index": 987 } ``` -### CartUserInputErrorType +### ConfigurableRequisitionListItem -#### Values +Contains details about configurable products added to a requisition list. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `COULD_NOT_FIND_CART_ITEM` | | -| `REQUIRED_PARAMETER_MISSING` | | -| `INVALID_PARAMETER_VALUE` | | -| `UNDEFINED` | | -| `PERMISSION_DENIED` | | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json -""PRODUCT_NOT_FOUND"" +{ + "configurable_options": [SelectedConfigurableOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} ``` -### CatalogAttributeApplyToEnum +### ConfigurableVariant -#### Values +Contains all the simple product variants of a configurable product. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `SIMPLE` | | -| `VIRTUAL` | | -| `BUNDLE` | | -| `DOWNLOADABLE` | | -| `CONFIGURABLE` | | -| `GROUPED` | | -| `CATEGORY` | | +| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | +| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | #### Example ```json -""SIMPLE"" +{ + "attributes": [ConfigurableAttributeOption], + "product": SimpleProduct +} ``` -### CatalogAttributeMetadata +### ConfigurableWishlistItem -Swatch attribute metadata. +A configurable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "apply_to": ["SIMPLE"], - "code": 4, - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_comparable": false, - "is_filterable": true, - "is_filterable_in_search": true, - "is_html_allowed_on_front": false, - "is_required": true, - "is_searchable": true, - "is_unique": false, - "is_used_for_price_rules": false, - "is_used_for_promo_rules": false, - "is_visible_in_advanced_search": false, - "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "label": "abc123", - "options": [CustomAttributeOptionInterface], - "swatch_input_type": "BOOLEAN", - "update_product_preview_image": false, - "use_product_image_for_swatch": true, - "used_in_product_listing": true + "added_at": "abc123", + "child_sku": "abc123", + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 } ``` -### CatalogRule +### ConfirmCancelOrderInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | Name of the catalog rule | +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | #### Example ```json -{"name": "abc123"} +{ + "confirmation_key": "xyz789", + "order_id": 4 +} ``` -### CategoryFilterInput +### ConfirmEmailInput -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. +Contains details about a customer email address to confirm. #### Input Fields | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | +| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | +| `email` - [`String!`](#string) | The email address to be confirmed. | #### Example ```json { - "category_uid": FilterEqualTypeInput, - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput, - "parent_category_uid": FilterEqualTypeInput, - "parent_id": FilterEqualTypeInput, - "url_key": FilterEqualTypeInput, - "url_path": FilterEqualTypeInput + "confirmation_key": "abc123", + "email": "xyz789" } ``` -### CategoryInterface +### ConfirmReturnInput -Contains the full set of attributes that can be returned in a category search. +#### Input Fields -#### Fields +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| Field Name | Description | -|------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | +#### Example -#### Possible Types +```json +{ + "confirmation_key": "abc123", + "order_id": 4 +} +``` -| CategoryInterface Types | -|----------------| -| [`CategoryTree`](#categorytree) | + + +### ConfirmationStatusEnum + +List of account confirmation statuses. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACCOUNT_CONFIRMED` | Account confirmed | +| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | #### Example ```json -{ - "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": "xyz789", - "default_sort_by": "abc123", - "description": "xyz789", - "display_mode": "abc123", - "filter_price_range": 123.45, - "id": 123, - "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 123, - "level": 987, - "meta_description": "abc123", - "meta_keywords": "xyz789", - "meta_title": "abc123", - "name": "abc123", - "path": "abc123", - "path_in_store": "xyz789", - "position": 987, - "product_count": 123, - "products": CategoryProducts, - "staged": true, - "uid": "4", - "updated_at": "abc123", - "url_key": "abc123", - "url_path": "abc123", - "url_suffix": "xyz789" -} +""ACCOUNT_CONFIRMED"" ``` -### CategoryProducts - -Contains details about the products assigned to a category. +### ContactUsInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#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. | +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](#string) | The email address of the shopper. | +| `name` - [`String!`](#string) | The full name of the shopper. | +| `telephone` - [`String`](#string) | The shopper's telephone number. | #### Example ```json { - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "total_count": 987 + "comment": "abc123", + "email": "abc123", + "name": "xyz789", + "telephone": "xyz789" } ``` -### CategoryResult +### ContactUsOutput -Contains a collection of `CategoryTree` objects and pagination information. +Contains the status of the request. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | #### Example ```json -{ - "items": [CategoryTree], - "page_info": SearchResultPageInfo, - "total_count": 987 -} +{"status": true} ``` -### CategoryTree +### CopyItemsBetweenRequisitionListsInput -Contains the hierarchy of categories. +An input object that defines the items in a requisition list to be copied. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | -| `children_count` - [`String`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | +| Input Field | Description | +|-------------|-------------| +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{ - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children": [CategoryTree], - "children_count": "abc123", - "cms_block": CmsBlock, - "created_at": "abc123", - "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", - "description": "abc123", - "display_mode": "xyz789", - "filter_price_range": 123.45, - "id": 987, - "image": "xyz789", - "include_in_menu": 987, - "is_anchor": 987, - "landing_page": 123, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "abc123", - "name": "xyz789", - "path": "xyz789", - "path_in_store": "abc123", - "position": 123, - "product_count": 987, - "products": CategoryProducts, - "redirect_code": 987, - "relative_url": "xyz789", - "staged": false, - "type": "CMS_PAGE", - "uid": 4, - "updated_at": "abc123", - "url_key": "xyz789", - "url_path": "abc123", - "url_suffix": "xyz789" -} +{"requisitionListItemUids": ["4"]} ``` -### CheckoutAgreement +### CopyItemsFromRequisitionListsOutput -Defines details about an individual checkout agreement. +Output of the request to copy items to the destination requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](#string) | Required. The text of the agreement. | -| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | -| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](#string) | The name given to the condition. | - -#### Example - -```json -{ - "agreement_id": 123, - "checkbox_text": "xyz789", - "content": "abc123", - "content_height": "abc123", - "is_html": false, - "mode": "AUTO", - "name": "xyz789" -} -``` - - - -### CheckoutAgreementMode - -Indicates how agreements are accepted. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `AUTO` | Conditions are automatically accepted upon checkout. | -| `MANUAL` | Shoppers must manually accept the conditions to place an order. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | #### Example ```json -""AUTO"" +{"requisition_list": RequisitionList} ``` -### CheckoutUserInputError +### CopyProductsBetweenWishlistsOutput -An error encountered while adding an item to the cart. +Contains the source and target wish lists after copying products. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](#string) | A localized error message. | -| `path` - [`[String]!`](#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 | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example ```json { - "code": "REORDER_NOT_AVAILABLE", - "message": "xyz789", - "path": ["xyz789"] + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] } ``` -### CheckoutUserInputErrorCodes - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REORDER_NOT_AVAILABLE` | | -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | - -#### Example - -```json -""REORDER_NOT_AVAILABLE"" -``` - - - -### ClearCartError - -Contains details about errors encountered when a customer clear cart. +### Country #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A localized error message | -| `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | +| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](#string) | The name of the country in English. | +| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | +| `id` - [`String`](#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{ + "available_regions": [Region], + "full_name_english": "abc123", + "full_name_locale": "abc123", + "id": "abc123", + "three_letter_abbreviation": "abc123", + "two_letter_abbreviation": "abc123" +} ``` -### ClearCartErrorType +### CountryCodeEnum + +The list of country codes. #### Values | Enum Value | Description | |------------|-------------| -| `NOT_FOUND` | | -| `UNAUTHORISED` | | -| `INACTIVE` | | -| `UNDEFINED` | | - -#### Example - -```json -""NOT_FOUND"" -``` - - - -### ClearCartInput - -Assigns a specific `cart_id` to the empty cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | +| `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 ```json -{"uid": 4} +""AF"" ``` -### ClearCartOutput +### CreateCompanyOutput -Output of the request to clear the customer cart. +Contains the response to the request to create a company. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clear cart items. | -| `errors` - [`[ClearCartError]`](#clearcarterror) | An array of errors encountered while clearing the cart item | +| `company` - [`Company!`](#company) | The new company instance. | #### Example ```json -{ - "cart": Cart, - "errors": [ClearCartError] -} +{"company": Company} ``` -### ClearCustomerCartOutput +### CreateCompanyRoleOutput -Output of the request to clear the customer cart. +Contains the response to the request to create a company role. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | #### Example ```json -{"cart": Cart, "status": true} +{"role": CompanyRole} ``` -### CloseNegotiableQuoteError +### CreateCompanyTeamOutput -#### Types +Contains the response to the request to create a company team. -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | #### Example ```json -NegotiableQuoteInvalidStateError +{"team": CompanyTeam} ``` -### CloseNegotiableQuoteOperationFailure +### CreateCompanyUserOutput -Contains details about a failed close operation on a negotiable quote. +Contains the response to the request to create a company user. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `user` - [`Customer!`](#customer) | The new company user instance. | #### Example ```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 -} +{"user": Customer} ``` -### CloseNegotiableQuoteOperationResult +### CreateCompareListInput -#### Types +Contains an array of product IDs to use for creating a compare list. -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | #### Example ```json -NegotiableQuoteUidOperationSuccess +{"products": ["4"]} ``` -### CloseNegotiableQuotesInput +### CreateGiftRegistryInput -Defines the negotiable quotes to mark as closed. +Defines a new gift registry. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | +| `message` - [`String!`](#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example ```json -{"quote_uids": [4]} +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "xyz789", + "gift_registry_type_uid": 4, + "message": "abc123", + "privacy_settings": "PRIVATE", + "registrants": [AddGiftRegistryRegistrantInput], + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" +} ``` -### CloseNegotiableQuotesOutput +### CreateGiftRegistryOutput -Contains the closed negotiable quotes and other negotiable quotes the company user can view. +Contains the results of a request to create a gift registry. #### Fields | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | -| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | #### Example ```json -{ - "closed_quotes": [NegotiableQuote], - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} +{"gift_registry": GiftRegistry} ``` -### CmsBlock - -Contains details about a specific CMS block. +### CreateGuestCartInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](#string) | The CMS block identifier. | -| `title` - [`String`](#string) | The title assigned to the CMS block. | +| Input Field | Description | +|-------------|-------------| +| `cart_uid` - [`ID`](#id) | Optional client-generated ID | #### Example ```json -{ - "content": "xyz789", - "identifier": "xyz789", - "title": "abc123" -} +{"cart_uid": 4} ``` -### CmsBlocks - -Contains an array CMS block items. +### CreateGuestCartOutput #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | +| `cart` - [`Cart`](#cart) | The newly created cart. | #### Example ```json -{"items": [CmsBlock]} +{"cart": Cart} ``` -### CmsPage +### CreatePayflowProTokenOutput -Contains details about a CMS page. +Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](#string) | The ID of a CMS page. | -| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | +| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | #### Example ```json { - "content": "xyz789", - "content_heading": "abc123", - "identifier": "xyz789", - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", - "page_layout": "xyz789", - "redirect_code": 123, - "relative_url": "abc123", - "title": "xyz789", - "type": "CMS_PAGE", - "url_key": "xyz789" + "response_message": "abc123", + "result": 123, + "result_code": 987, + "secure_token": "abc123", + "secure_token_id": "abc123" } ``` -### ColorSwatchData +### CreatePaymentOrderInput -#### Fields +Contains payment order details that are used while processing the payment order -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json -{"value": "xyz789"} +{ + "cartId": "xyz789", + "location": "PRODUCT_DETAIL", + "methodCode": "abc123", + "paymentSource": "abc123", + "vaultIntent": false +} ``` -### CompaniesSortFieldEnum +### CreatePaymentOrderOutput -The fields available for sorting the customer companies. +Contains payment order details that are used while processing the payment order -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `NAME` | The name of the company. | +| `amount` - [`Float`](#float) | The amount of the payment order | +| `currency_code` - [`String`](#string) | The currency of the payment order | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json -""NAME"" +{ + "amount": 987.65, + "currency_code": "abc123", + "id": "abc123", + "mp_order_id": "abc123", + "status": "abc123" +} ``` -### CompaniesSortInput +### CreateProductReviewInput -Specifies which field to sort on, and whether to return the results in ascending or descending order. +Defines a new product review. #### Input Fields | Input Field | Description | |-------------|-------------| -| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json -{"field": "NAME", "order": "ASC"} +{ + "nickname": "xyz789", + "ratings": [ProductReviewRatingInput], + "sku": "xyz789", + "summary": "abc123", + "text": "abc123" +} ``` -### Company +### CreateProductReviewOutput -Contains the output schema for a company. +Contains the completed product review. #### Fields | Field Name | Description | |------------|-------------| -| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | -| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | -| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | -| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | -| `email` - [`String`](#string) | The email address of the company contact. | -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | -| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | -| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | -| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | -| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | -| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | -| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `review` - [`ProductReview!`](#productreview) | Product review details. | #### Example ```json -{ - "acl_resources": [CompanyAclResource], - "company_admin": Customer, - "credit": CompanyCredit, - "credit_history": CompanyCreditHistory, - "email": "xyz789", - "id": "4", - "legal_address": CompanyLegalAddress, - "legal_name": "xyz789", - "name": "xyz789", - "payment_methods": ["abc123"], - "reseller_id": "abc123", - "role": CompanyRole, - "roles": CompanyRoles, - "sales_representative": CompanySalesRepresentative, - "structure": CompanyStructure, - "team": CompanyTeam, - "user": Customer, - "users": CompanyUsers, - "vat_tax_id": "xyz789" -} +{"review": ProductReview} ``` -### CompanyAclResource +### CreatePurchaseOrderApprovalRuleConditionAmountInput -Contains details about the access control list settings of a resource. +Specifies the amount and currency to evaluate. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | -| `text` - [`String`](#string) | The label assigned to the ACL resource. | +| Input Field | Description | +|-------------|-------------| +| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | +| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | #### Example ```json -{ - "children": [CompanyAclResource], - "id": "4", - "sort_order": 987, - "text": "abc123" -} +{"currency": "AFN", "value": 123.45} ``` -### CompanyAdminInput +### CreatePurchaseOrderApprovalRuleConditionInput -Defines the input schema for creating a company administrator. +Defines a set of conditions that apply to a rule. #### Input Fields | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The company administrator's custom attributes. | -| `email` - [`String!`](#string) | The email address of the company administrator. | -| `firstname` - [`String!`](#string) | The company administrator's first name. | -| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](#string) | The job title of the company administrator. | -| `lastname` - [`String!`](#string) | The company administrator's last name. | -| `telephone` - [`String`](#string) | The phone number of the company administrator. | +| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example ```json { - "custom_attributes": [AttributeValueInput], - "email": "abc123", - "firstname": "xyz789", - "gender": 123, - "job_title": "xyz789", - "lastname": "abc123", - "telephone": "abc123" + "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN", + "quantity": 123 } ``` -### CompanyBasicInfo +### CreateRequisitionListInput -The minimal required information to identify and display the company. +An input object that identifies and describes a new requisition list. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the requisition list. | +| `name` - [`String!`](#string) | The name assigned to the requisition list. | #### Example ```json { - "id": 4, - "legal_name": "abc123", + "description": "xyz789", "name": "xyz789" } ``` -### CompanyCreateInput +### CreateRequisitionListOutput -Defines the input schema for creating a new company. +Output of the request to create a requisition list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](#string) | The email address of the company contact. | -| `company_name` - [`String!`](#string) | The name of the company to create. | -| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | #### Example ```json -{ - "company_admin": CompanyAdminInput, - "company_email": "xyz789", - "company_name": "xyz789", - "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "abc123", - "reseller_id": "abc123", - "vat_tax_id": "abc123" -} +{"requisition_list": RequisitionList} ``` -### CompanyCredit +### CreateVaultCardPaymentTokenInput -Contains company credit balances and limits. +Describe the variables needed to create a vault payment token -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](#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. | +| Input Field | Description | +|-------------|-------------| +| `card_description` - [`String`](#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json { - "available_credit": Money, - "credit_limit": Money, - "outstanding_balance": Money + "card_description": "abc123", + "setup_token_id": "xyz789" } ``` -### CompanyCreditHistory +### CreateVaultCardPaymentTokenOutput -Contains details about prior company credit operations. +The vault token id and information about the payment source #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | +| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](#string) | The vault payment token information | #### Example ```json { - "items": [CompanyCreditOperation], - "page_info": SearchResultPageInfo, - "total_count": 123 + "payment_source": PaymentSourceOutput, + "vault_token_id": "abc123" } ``` -### CompanyCreditHistoryFilterInput +### CreateVaultCardSetupTokenInput -Defines a filter for narrowing the results of a credit history search. +Describe the variables needed to create a vault card setup token #### Input Fields | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | +| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | #### Example ```json { - "custom_reference_number": "xyz789", - "operation_type": "ALLOCATION", - "updated_by": "abc123" + "setup_token": VaultSetupTokenInput, + "three_ds_mode": "OFF" } ``` -### CompanyCreditOperation +### CreateVaultCardSetupTokenOutput -Contains details about a single company credit operation. +The setup token id information #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | -| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](#string) | The date the operation occurred. | -| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | +| `setup_token` - [`String!`](#string) | The setup token id | #### Example ```json -{ - "amount": Money, - "balance": CompanyCredit, - "custom_reference_number": "xyz789", - "date": "abc123", - "type": "ALLOCATION", - "updated_by": CompanyCreditOperationUser -} +{"setup_token": "abc123"} ``` -### CompanyCreditOperationType +### CreateWishlistInput -#### Values +Defines the name and visibility of a new wish list. -| Enum Value | Description | -|------------|-------------| -| `ALLOCATION` | | -| `UPDATE` | | -| `PURCHASE` | | -| `REIMBURSEMENT` | | -| `REFUND` | | -| `REVERT` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -""ALLOCATION"" +{"name": "xyz789", "visibility": "PUBLIC"} ``` -### CompanyCreditOperationUser +### CreateWishlistOutput -Defines the administrator or company user that submitted a company credit operation. +Contains the wish list. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | -| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | - -#### Example - -```json -{"name": "abc123", "type": "CUSTOMER"} -``` - - - -### CompanyCreditOperationUserType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CUSTOMER` | | -| `ADMIN` | | +| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | #### Example ```json -""CUSTOMER"" +{"wishlist": Wishlist} ``` -### CompanyInvitationInput +### CreditCardDetailsInput -Defines the input schema for accepting the company invitation. +Required fields for Payflow Pro and Payments Pro credit card payments. #### Input Fields | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | -| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | +| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](#string) | The credit card type. | #### Example ```json { - "code": "abc123", - "role_id": 4, - "user": CompanyInvitationUserInput + "cc_exp_month": 987, + "cc_exp_year": 987, + "cc_last_4": 123, + "cc_type": "abc123" } ``` -### CompanyInvitationOutput +### CreditMemo -The result of accepting the company invitation. +Contains credit memo details. #### Fields | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | +| `number` - [`String!`](#string) | The sequential credit memo number. | +| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example ```json -{"success": true} +{ + "comments": [SalesCommentItem], + "id": "4", + "items": [CreditMemoItemInterface], + "number": "abc123", + "total": CreditMemoTotal +} ``` -### CompanyInvitationUserInput - -Company user attributes in the invitation. +### CreditMemoItem -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_id` - [`ID!`](#id) | The company unique identifier. | -| `customer_id` - [`ID!`](#id) | The customer unique identifier. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The phone number of the company user. | +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json { - "company_id": 4, - "customer_id": 4, - "job_title": "xyz789", - "status": "ACTIVE", - "telephone": "xyz789" + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` -### CompanyLegalAddress +### CreditMemoItemInterface -Contains details about the address where the company is registered to conduct business. +Credit memo item details. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | -| `postcode` - [`String`](#string) | The company's postal code. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](#string) | The company's phone number. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Possible Types + +| CreditMemoItemInterface Types | +|----------------| +| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | +| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`CreditMemoItem`](#creditmemoitem) | #### Example ```json { - "city": "xyz789", - "country_code": "AF", - "postcode": "abc123", - "region": CustomerAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` -### CompanyLegalAddressCreateInput +### CreditMemoTotal -Defines the input schema for defining a company's legal address. +Contains credit memo price details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | -| `postcode` - [`String!`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](#string) | The primary phone number of the company. | +| Field Name | Description | +|------------|-------------| +| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | #### Example ```json { - "city": "abc123", - "country_id": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "abc123" + "adjustment": Money, + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money } ``` -### CompanyLegalAddressUpdateInput - -Defines the input schema for updating a company's legal address. +### Currency -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](#string) | The primary phone number of the company. | +| Field Name | Description | +|------------|-------------| +| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | +| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | #### Example ```json { - "city": "xyz789", - "country_id": "AF", - "postcode": "abc123", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "xyz789" + "available_currency_codes": ["abc123"], + "base_currency_code": "abc123", + "base_currency_symbol": "xyz789", + "default_display_currecy_code": "abc123", + "default_display_currecy_symbol": "xyz789", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "xyz789", + "exchange_rates": [ExchangeRate] } ``` -### CompanyRole +### CurrencyEnum -Contails details about a single role. +The list of available currency codes. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""AFN"" +``` + + + +### CustomAttributeMetadata + +Defines an array of custom attributes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Attribute]`](#attribute) | An array of attributes. | + +#### Example + +```json +{"items": [Attribute]} +``` + + + +### CustomAttributeMetadataInterface + +An interface containing fields that define the EAV attribute. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | -| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | + +#### Possible Types + +| CustomAttributeMetadataInterface Types | +|----------------| +| [`AttributeMetadata`](#attributemetadata) | +| [`CatalogAttributeMetadata`](#catalogattributemetadata) | +| [`CustomerAttributeMetadata`](#customerattributemetadata) | +| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | #### Example ```json { - "id": "4", - "name": "xyz789", - "permissions": [CompanyAclResource], - "users_count": 987 + "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] } ``` -### CompanyRoleCreateInput +### CustomAttributeOptionInterface -Defines the input schema for creating a company role. +#### Fields -#### Input Fields +| Field Name | Description | +|------------|-------------| +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +#### Possible Types + +| CustomAttributeOptionInterface Types | +|----------------| +| [`AttributeOptionMetadata`](#attributeoptionmetadata) | #### Example ```json { - "name": "abc123", - "permissions": ["abc123"] + "is_default": true, + "label": "xyz789", + "value": "abc123" } ``` -### CompanyRoleUpdateInput +### Customer -Defines the input schema for updating a company role. +Defines the customer name, addresses, and other details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name of the role to update. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| Field Name | Description | +|------------|-------------| +| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | +| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | +| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](#string) | The customer's email address. Required. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | +| `group` - [`CustomerGroup`](#customergroup) | Name of the customer group assigned to the customer | +| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`Int`](#int) | The ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `orders` - [`CustomerOrders`](#customerorders) | | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | +| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | +| `segments` - [`[CustomerSegment]`](#customersegment) | Customer segments associated with the current customer | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | +| `telephone` - [`String`](#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](#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. | #### Example ```json { - "id": "4", - "name": "abc123", - "permissions": ["abc123"] + "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": "xyz789", + "default_billing": "xyz789", + "default_shipping": "xyz789", + "dob": "xyz789", + "email": "abc123", + "firstname": "xyz789", + "gender": 123, + "gift_registries": [GiftRegistry], + "gift_registry": GiftRegistry, + "group": CustomerGroup, + "group_id": 123, + "id": 987, + "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": [CustomerSegment], + "status": "ACTIVE", + "store_credit": CustomerStoreCredit, + "structure_id": "4", + "suffix": "xyz789", + "taxvat": "xyz789", + "team": CompanyTeam, + "telephone": "xyz789", + "wishlist": Wishlist, + "wishlist_v2": Wishlist, + "wishlists": [Wishlist] } ``` -### CompanyRoles +### CustomerAddress -Contains an array of roles. +Contains detailed information about a customer's billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | +| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. | +| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "items": [CompanyRole], - "page_info": SearchResultPageInfo, - "total_count": 123 + "city": "xyz789", + "company": "xyz789", + "country_code": "AF", + "country_id": "abc123", + "custom_attributes": [CustomerAddressAttribute], + "custom_attributesV2": [AttributeValueInterface], + "customer_id": 123, + "default_billing": true, + "default_shipping": true, + "extension_attributes": [CustomerAddressAttribute], + "fax": "abc123", + "firstname": "abc123", + "id": 987, + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": CustomerAddressRegion, + "region_id": 987, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "abc123" } ``` -### CompanySalesRepresentative +### CustomerAddressAttribute -Contains details about a company sales representative. +Specifies the attribute code and value of a customer address attribute. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String`](#string) | The email address of the company sales representative. | -| `firstname` - [`String`](#string) | The company sales representative's first name. | -| `lastname` - [`String`](#string) | The company sales representative's last name. | +| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](#string) | The value assigned to the customer address attribute. | #### Example ```json { - "email": "xyz789", - "firstname": "xyz789", - "lastname": "abc123" + "attribute_code": "abc123", + "value": "xyz789" } ``` -### CompanyStructure +### CustomerAddressAttributeInput -Contains an array of the individual nodes that comprise the company structure. +Specifies the attribute code and value of a customer attribute. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | +| `value` - [`String!`](#string) | The value assigned to the attribute. | #### Example ```json -{"items": [CompanyStructureItem]} +{ + "attribute_code": "abc123", + "value": "abc123" +} ``` -### CompanyStructureEntity +### CustomerAddressInput -#### Types +Contains details about a billing or shipping address. -| Union Types | -|-------------| -| [`CompanyTeam`](#companyteam) | -| [`Customer`](#customer) | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | | +| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | | +| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json -CompanyTeam +{ + "city": "abc123", + "company": "abc123", + "country_code": "AF", + "country_id": "AF", + "custom_attributes": [CustomerAddressAttributeInput], + "custom_attributesV2": [AttributeValueInput], + "default_billing": false, + "default_shipping": true, + "fax": "xyz789", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" +} ``` -### CompanyStructureItem +### CustomerAddressRegion -Defines an individual node in the company structure. +Defines the customer's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "entity": CompanyTeam, - "id": "4", - "parent_id": 4 + "region": "abc123", + "region_code": "abc123", + "region_id": 123 } ``` -### CompanyStructureUpdateInput +### CustomerAddressRegionInput -Defines the input schema for updating the company structure. +Defines the customer's state or province. #### Input Fields | Input Field | Description | |-------------|-------------| -| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json -{"parent_tree_id": "4", "tree_id": 4} +{ + "region": "xyz789", + "region_code": "abc123", + "region_id": 987 +} ``` -### CompanyTeam - -Describes a company team. +### CustomerAddresses #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](#string) | The display name of the team. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer addresses. | #### Example ```json { - "description": "abc123", - "id": "4", - "name": "abc123", - "structure_id": 4 + "items": [CustomerAddress], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### CompanyTeamCreateInput +### CustomerAttributeMetadata -Defines the input schema for creating a company team. +Customer attribute metadata. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `name` - [`String!`](#string) | The display name of the team. | -| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "description": "xyz789", - "name": "abc123", - "target_id": 4 + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": false, + "is_unique": true, + "label": "xyz789", + "multiline_count": 123, + "options": [CustomAttributeOptionInterface], + "sort_order": 123, + "validate_rules": [ValidationRule] } ``` -### CompanyTeamUpdateInput +### CustomerCreateInput -Defines the input schema for updating a company team. +An input object for creating a customer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](#string) | The display name of the team. | +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | | +| `email` - [`String!`](#string) | The customer's email address. | +| `firstname` - [`String!`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "description": "xyz789", - "id": 4, - "name": "abc123" + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "xyz789", + "dob": "xyz789", + "email": "xyz789", + "firstname": "abc123", + "gender": 987, + "is_subscribed": false, + "lastname": "abc123", + "middlename": "xyz789", + "password": "xyz789", + "prefix": "xyz789", + "suffix": "xyz789", + "taxvat": "abc123" } ``` -### CompanyUpdateInput +### CustomerDownloadableProduct -Defines the input schema for updating a company. +Contains details about a single downloadable product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_email` - [`String`](#string) | The email address of the company contact. | -| `company_name` - [`String`](#string) | The name of the company to update. | -| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `date` - [`String`](#string) | The date and time the purchase was made. | +| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "company_email": "abc123", - "company_name": "xyz789", - "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "xyz789", - "reseller_id": "abc123", - "vat_tax_id": "abc123" + "date": "abc123", + "download_url": "xyz789", + "order_increment_id": "abc123", + "remaining_downloads": "xyz789", + "status": "xyz789" } ``` -### CompanyUserCreateInput +### CustomerDownloadableProducts -Defines the input schema for creating a company user. +Contains a list of downloadable products. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The company user's email address | -| `firstname` - [`String!`](#string) | The company user's first name. | -| `job_title` - [`String!`](#string) | The company user's job title or function. | -| `lastname` - [`String!`](#string) | The company user's last name. | -| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`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!`](#string) | The company user's phone number. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | #### Example ```json -{ - "email": "xyz789", - "firstname": "xyz789", - "job_title": "xyz789", - "lastname": "abc123", - "role_id": 4, - "status": "ACTIVE", - "target_id": 4, - "telephone": "xyz789" -} +{"items": [CustomerDownloadableProduct]} ``` -### CompanyUserStatusEnum +### CustomerGroup -Defines the list of company user status values. +Data of customer group. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACTIVE` | Only active users. | -| `INACTIVE` | Only inactive users. | +| `name` - [`String`](#string) | The name of customer group. | #### Example ```json -""ACTIVE"" +{"name": "abc123"} ``` -### CompanyUserUpdateInput +### CustomerInput -Defines the input schema for updating a company user. +An input object that assigns or updates customer attributes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String`](#string) | The company user's email address. | -| `firstname` - [`String`](#string) | The company user's first name. | -| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](#string) | The company user's job title or function. | -| `lastname` - [`String`](#string) | The company user's last name. | -| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The company user's phone number. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | | +| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "email": "xyz789", + "date_of_birth": "xyz789", + "dob": "xyz789", + "email": "abc123", "firstname": "xyz789", - "id": "4", - "job_title": "xyz789", + "gender": 123, + "is_subscribed": true, "lastname": "xyz789", - "role_id": 4, - "status": "ACTIVE", - "telephone": "abc123" + "middlename": "abc123", + "password": "xyz789", + "prefix": "abc123", + "suffix": "abc123", + "taxvat": "abc123" } ``` -### CompanyUsers +### CustomerOrder -Contains details about company users. +Contains details about each of the customer's orders. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The number of objects returned. | +| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | +| `customer_info` - [`OrderCustomerInfo!`](#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](#string) | The order number. | +| `order_date` - [`String!`](#string) | The date the order was placed. | +| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | +| `order_status_change_date` - [`String!`](#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](#string) | The delivery method for the order. | +| `status` - [`String!`](#string) | The current status of the order. | +| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | #### Example ```json { - "items": [Customer], - "page_info": SearchResultPageInfo, - "total_count": 123 + "applied_coupons": [AppliedCoupon], + "applied_gift_cards": [ApplyGiftCardToOrder], + "available_actions": ["REORDER"], + "billing_address": OrderAddress, + "carrier": "xyz789", + "comments": [SalesCommentItem], + "created_at": "abc123", + "credit_memos": [CreditMemo], + "customer_info": OrderCustomerInfo, + "email": "abc123", + "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": "abc123", + "order_number": "abc123", + "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", + "total": OrderTotal } ``` -### CompanyUsersFilterInput +### CustomerOrderSortInput -Defines the filter for returning a list of company users. +CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. #### Input Fields | Input Field | Description | |-------------|-------------| -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | +| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | #### Example ```json -{"status": "ACTIVE"} +{"sort_direction": "ASC", "sort_field": "NUMBER"} ``` -### ComparableAttribute +### CustomerOrderSortableField -Contains an attribute code that is used for product comparisons. +Specifies the field to use for sorting -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `NUMBER` | Sorts customer orders by number | +| `CREATED_AT` | Sorts customer orders by created_at field | #### Example ```json -{ - "code": "xyz789", - "label": "abc123" -} +""NUMBER"" ``` -### ComparableItem +### CustomerOrders -Defines an object used to iterate through items for product comparisons. +The collection of orders that match the conditions defined in the filter. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | +| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | +| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer orders. | #### Example ```json { - "attributes": [ProductAttribute], - "product": ProductInterface, - "uid": 4 + "date_of_first_order": "xyz789", + "items": [CustomerOrder], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### CompareList +### CustomerOrdersFilterInput -Contains iterable information such as the array of items, the count, and attributes that represent the compare list. +Identifies the filter to use for filtering orders. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](#int) | The number of items in the compare list. | -| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | +| Input Field | Description | +|-------------|-------------| +| `grand_total` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filters by order status. | #### Example ```json { - "attributes": [ComparableAttribute], - "item_count": 987, - "items": [ComparableItem], - "uid": "4" + "grand_total": FilterRangeTypeInput, + "number": FilterStringTypeInput, + "order_date": FilterRangeTypeInput, + "status": FilterEqualTypeInput } ``` -### ComplexTextValue +### CustomerOutput + +Contains details about a newly-created or updated customer. #### Fields | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | #### Example ```json -{"html": "abc123"} +{"customer": Customer} ``` -### ConfigurableAttributeOption +### CustomerPaymentTokens -Contains details about a configurable product attribute option. +Contains payment tokens stored in the customer's vault. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The ID assigned to the attribute. | -| `label` - [`String`](#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | +| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | #### Example ```json -{ - "code": "abc123", - "label": "abc123", - "uid": 4, - "value_index": 987 -} +{"items": [PaymentToken]} ``` -### ConfigurableCartItem +### CustomerSegment -An implementation for configurable product cart items. +Customer segment. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `apply_to` - [`CustomerSegmentApplyTo!`](#customersegmentapplyto) | Customer segment is applicable to visitor, registered customer or both. | +| `description` - [`String`](#string) | Customer segment description. | +| `name` - [`String!`](#string) | Customer segment name. | #### Example ```json { - "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": 123.45, - "min_qty": 123.45, - "not_available_message": "xyz789", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "apply_to": "BOTH", + "description": "xyz789", + "name": "xyz789" } ``` -### ConfigurableOptionAvailableForSelection +### CustomerSegmentApplyTo -Describes configurable options that have been selected and can be selected as a result of the previous selections. +Customer segment is applicable to visitor, registered customers or both. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOTH` | Customer segment is applicable to visitor and registered customers. | +| `REGISTERED` | Customer segment is applicable to registered customers. | +| `VISITOR` | Customer segment is applicable to visitors/guests. | + +#### Example + +```json +""BOTH"" +``` + + + +### CustomerStoreCredit + +Contains store credit information with balance and history. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | +| `balance_history` - [`CustomerStoreCreditHistory`](#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. | +| `current_balance` - [`Money`](#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example ```json { - "attribute_code": "abc123", - "option_value_uids": [4] + "balance_history": CustomerStoreCreditHistory, + "current_balance": Money, + "enabled": true } ``` -### ConfigurableOrderItem +### CustomerStoreCreditHistory + +Lists changes to the amount of store credit available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of items returned. | #### Example ```json { - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": 4, - "parent_sku": "abc123", - "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": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "abc123" + "items": [CustomerStoreCreditHistoryItem], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### ConfigurableProduct +### CustomerStoreCreditHistoryItem -Defines basic features of a configurable product and its simple product variants. +Contains store credit history information. #### Fields | Field Name | Description | |------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | -| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `action` - [`String`](#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | #### Example ```json { - "activity": "abc123", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "collar": "xyz789", - "color": 987, - "configurable_options": [ConfigurableProductOptions], - "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "eco_collection": 987, - "erin_recommends": 987, - "features_bags": "abc123", - "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": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, - "name": "xyz789", - "new": 987, - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "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": 123, - "reviews": ProductReviews, - "rules": [CatalogRule], - "sale": 987, - "short_description": ComplexTextValue, - "size": 123, - "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": "xyz789", - "style_bags": "abc123", - "style_bottom": "abc123", - "style_general": "xyz789", - "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": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "variants": [ConfigurableVariant], - "websites": [Website], - "weight": 123.45 + "action": "xyz789", + "actual_balance": Money, + "balance_change": Money, + "date_time_changed": "xyz789" } ``` -### ConfigurableProductCartItemInput +### CustomerToken + +Contains a customer authorization token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `token` - [`String`](#string) | The customer authorization token. | + +#### Example + +```json +{"token": "abc123"} +``` + + + +### CustomerUpdateInput + +An input object for updating a customer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | -| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](#string) | | +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "parent_sku": "xyz789", - "variant_sku": "xyz789" + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "xyz789", + "dob": "abc123", + "firstname": "abc123", + "gender": 987, + "is_subscribed": false, + "lastname": "abc123", + "middlename": "abc123", + "prefix": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789" } ``` -### ConfigurableProductOption +### CustomizableAreaOption -Contains details about configurable product options. +Contains information about a text area that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](#string) | The display name of the option. | -| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | -| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "attribute_code": "xyz789", - "label": "abc123", - "uid": 4, - "values": [ConfigurableProductOptionValue] + "option_id": 123, + "product_sku": "abc123", + "required": false, + "sort_order": 987, + "title": "abc123", + "uid": "4", + "value": CustomizableAreaValue } ``` -### ConfigurableProductOptionValue +### CustomizableAreaValue -Defines a value for a configurable product option. +Defines the price and sku of a product whose page contains a customized text area. #### Fields | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](#id) | The unique ID of the value. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "is_available": false, - "is_use_default": false, - "label": "abc123", - "swatch": SwatchDataInterface, + "max_characters": 123, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", "uid": "4" } ``` -### ConfigurableProductOptions +### CustomizableCheckboxOption -Defines configurable attributes for the specified product. +Contains information about a set of checkbox values that are defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | -| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json { - "attribute_code": "xyz789", - "attribute_id": "abc123", - "attribute_id_v2": 987, - "attribute_uid": 4, - "id": 987, - "label": "abc123", - "position": 123, - "product_id": 987, + "option_id": 123, + "required": true, + "sort_order": 987, + "title": "abc123", "uid": 4, - "use_default": false, - "values": [ConfigurableProductOptionsValues] + "value": [CustomizableCheckboxValue] } ``` -### ConfigurableProductOptionsSelection +### CustomizableCheckboxValue -Contains metadata corresponding to the selected configurable options. +Defines the price and sku of a product whose page contains a customized set of checkbox values. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | -| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | -| `variant` - [`SimpleProduct`](#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. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "configurable_options": [ConfigurableProductOption], - "media_gallery": [MediaGalleryInterface], - "options_available_for_selection": [ - ConfigurableOptionAvailableForSelection - ], - "variant": SimpleProduct -} -``` + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 123, + "title": "xyz789", + "uid": "4" +} +``` -### ConfigurableProductOptionsValues +### CustomizableDateOption -Contains the index number assigned to a configurable product option. +Contains information about a date picker that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](#string) | The label of the product on the default store. | -| `label` - [`String`](#string) | The label of the product. | -| `store_label` - [`String`](#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example ```json { - "default_label": "xyz789", - "label": "xyz789", - "store_label": "xyz789", - "swatch_data": SwatchDataInterface, - "uid": "4", - "use_default_value": false, - "value_index": 123 + "option_id": 987, + "product_sku": "xyz789", + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": CustomizableDateValue } ``` -### ConfigurableRequisitionListItem +### CustomizableDateTypeEnum -Contains details about configurable products added to a requisition list. +Defines the customizable date type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `DATE` | | +| `DATE_TIME` | | +| `TIME` | | + +#### Example + +```json +""DATE"" +``` + + + +### CustomizableDateValue + +Defines the price and sku of a product whose page contains a customized date picker. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "configurable_options": [SelectedConfigurableOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "type": "DATE", + "uid": "4" } ``` -### ConfigurableVariant +### CustomizableDropDownOption -Contains all the simple product variants of a configurable product. +Contains information about a drop down menu that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | #### Example ```json { - "attributes": [ConfigurableAttributeOption], - "product": SimpleProduct + "option_id": 123, + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": [CustomizableDropDownValue] } ``` -### ConfigurableWishlistItem +### CustomizableDropDownValue -A configurable product wish list item. +Defines the price and sku of a product whose page contains a customized drop down menu. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "added_at": "xyz789", - "child_sku": "abc123", - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": "4" } ``` -### ConfirmCancelOrderInput +### CustomizableFieldOption -#### Input Fields +Contains information about a text field that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "confirmation_key": "abc123", - "order_id": 4 + "option_id": 123, + "product_sku": "xyz789", + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": "4", + "value": CustomizableFieldValue } ``` -### ConfirmEmailInput +### CustomizableFieldValue -Contains details about a customer email address to confirm. +Defines the price and sku of a product whose page contains a customized text field. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| Field Name | Description | +|------------|-------------| +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "confirmation_key": "xyz789", - "email": "abc123" + "max_characters": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "uid": 4 } ``` -### ConfirmReturnInput +### CustomizableFileOption -#### Input Fields +Contains information about a file picker that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example ```json { - "confirmation_key": "abc123", - "order_id": "4" + "option_id": 123, + "product_sku": "xyz789", + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": CustomizableFileValue } ``` -### ConfirmationStatusEnum +### CustomizableFileValue -List of account confirmation statuses. +Defines the price and sku of a product whose page contains a customized file picker. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACCOUNT_CONFIRMED` | Account confirmed | -| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | +| `file_extension` - [`String`](#string) | The file extension to accept. | +| `image_size_x` - [`Int`](#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](#int) | The maximum height of an image. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json -""ACCOUNT_CONFIRMED"" +{ + "file_extension": "abc123", + "image_size_x": 123, + "image_size_y": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "uid": 4 +} ``` -### ContactUsInput +### CustomizableMultipleOption -#### Input Fields +Contains information about a multiselect that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](#string) | The email address of the shopper. | -| `name` - [`String!`](#string) | The full name of the shopper. | -| `telephone` - [`String`](#string) | The shopper's telephone number. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example ```json { - "comment": "xyz789", - "email": "abc123", - "name": "xyz789", - "telephone": "xyz789" + "option_id": 987, + "required": true, + "sort_order": 123, + "title": "xyz789", + "uid": 4, + "value": [CustomizableMultipleValue] } ``` -### ContactUsOutput +### CustomizableMultipleValue -Contains the status of the request. +Defines the price and sku of a product whose page contains a customized multiselect. #### Fields | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json -{"status": true} +{ + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 987, + "title": "abc123", + "uid": "4" +} ``` -### CopyItemsBetweenRequisitionListsInput +### CustomizableOptionInput -An input object that defines the items in a requisition list to be copied. +Defines a customizable option. #### Input Fields | Input Field | Description | |-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| `id` - [`Int`](#int) | The customizable option ID of the product. | +| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](#string) | The string value of the option. | #### Example ```json -{"requisitionListItemUids": [4]} +{ + "id": 987, + "uid": "4", + "value_string": "xyz789" +} ``` -### CopyItemsFromRequisitionListsOutput +### CustomizableOptionInterface -Output of the request to copy items to the destination requisition list. +Contains basic information about a customizable option. It can be implemented by several types of configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | + +#### Possible Types + +| CustomizableOptionInterface Types | +|----------------| +| [`CustomizableAreaOption`](#customizableareaoption) | +| [`CustomizableDateOption`](#customizabledateoption) | +| [`CustomizableDropDownOption`](#customizabledropdownoption) | +| [`CustomizableMultipleOption`](#customizablemultipleoption) | +| [`CustomizableFieldOption`](#customizablefieldoption) | +| [`CustomizableFileOption`](#customizablefileoption) | +| [`CustomizableRadioOption`](#customizableradiooption) | +| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | #### Example ```json -{"requisition_list": RequisitionList} +{ + "option_id": 123, + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": 4 +} ``` -### CopyProductsBetweenWishlistsOutput +### CustomizableProductInterface -Contains the source and target wish lists after copying products. +Contains information about customizable product options. #### Fields | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | + +#### Possible Types + +| CustomizableProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`GiftCardProduct`](#giftcardproduct) | + +#### Example + +```json +{"options": [CustomizableOptionInterface]} +``` + + + +### CustomizableRadioOption + +Contains information about a set of radio buttons that are defined as part of a customizable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example ```json { - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] + "option_id": 123, + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": 4, + "value": [CustomizableRadioValue] } ``` -### Country +### CustomizableRadioValue + +Defines the price and sku of a product whose page contains a customized set of radio buttons. #### Fields | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](#string) | The name of the country in English. | -| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | -| `id` - [`String`](#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "abc123", - "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "option_type_id": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 987, + "title": "xyz789", + "uid": 4 } ``` -### CountryCodeEnum +### DeleteCompanyRoleOutput -The list of country codes. +Contains the response to the request to delete the company role. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `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 &amp; 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 | +| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | + +#### Example + +```json +{"success": true} +``` + + + +### DeleteCompanyTeamOutput + +Contains the status of the request to delete a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | + +#### Example + +```json +{"success": false} +``` + + + +### DeleteCompanyUserOutput + +Contains the response to the request to delete the company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | + +#### Example + +```json +{"success": true} +``` + + + +### DeleteCompareListOutput + +Contains the results of the request to delete a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | + +#### Example + +```json +{"result": true} +``` + + + +### DeleteNegotiableQuoteError + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | + +#### Example + +```json +NegotiableQuoteInvalidStateError +``` + + + +### DeleteNegotiableQuoteOperationFailure + +Contains details about a failed delete operation on a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": 4 +} +``` + + + +### DeleteNegotiableQuoteOperationResult + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | + +#### Example + +```json +NegotiableQuoteUidOperationSuccess +``` + + + +### DeleteNegotiableQuoteTemplateInput + +Specifies the quote template id of the quote template to delete + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": "4"} +``` + + + +### DeleteNegotiableQuotesInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | + +#### Example + +```json +{"quote_uids": ["4"]} +``` + + + +### DeleteNegotiableQuotesOutput + +Contains a list of undeleted negotiable quotes the company user can view. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | + +#### Example + +```json +{ + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" +} +``` + + + +### DeletePaymentTokenOutput + +Indicates whether the request succeeded and returns the remaining customer payment tokens. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | + +#### Example + +```json +{ + "customerPaymentTokens": CustomerPaymentTokens, + "result": true +} +``` + + + +### DeletePurchaseOrderApprovalRuleError + +Contains details about an error that occurred when deleting an approval rule . + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The text of the error message. | +| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | + +#### Example + +```json +{"message": "xyz789", "type": "UNDEFINED"} +``` + + + +### DeletePurchaseOrderApprovalRuleErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNDEFINED` | | +| `NOT_FOUND` | | + +#### Example + +```json +""UNDEFINED"" +``` + + + +### DeletePurchaseOrderApprovalRuleInput + +Specifies the IDs of the approval rules to delete. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | + +#### Example + +```json +{"approval_rule_uids": [4]} +``` + + + +### DeletePurchaseOrderApprovalRuleOutput + +Contains any errors encountered while attempting to delete approval rules. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | + +#### Example + +```json +{"errors": [DeletePurchaseOrderApprovalRuleError]} +``` + + + +### DeleteRequisitionListItemsOutput + +Output of the request to remove items from the requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### DeleteRequisitionListOutput + +Indicates whether the request to delete the requisition list was successful. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | + +#### Example + +```json +{"requisition_lists": RequisitionLists, "status": true} +``` + + + +### DeleteWishlistOutput + +Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | + +#### Example + +```json +{"status": false, "wishlists": [Wishlist]} +``` + + + +### Discount + +Specifies the discount type and value for quote line item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | +| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | +| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](#string) | A description of the discount. | +| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](#float) | Quote line item discount value. | + +#### Example + +```json +{ + "amount": Money, + "applied_to": "ITEM", + "coupon": AppliedCoupon, + "is_discounting_locked": false, + "label": "xyz789", + "type": "abc123", + "value": 987.65 +} +``` + + + +### DownloadableCartItem + +An implementation for downloadable product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "id": "xyz789", + "is_available": true, + "links": [DownloadableProductLinks], + "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, + "samples": [DownloadableProductSamples], + "uid": "4" +} +``` + + + +### DownloadableCreditMemoItem + +Defines downloadable product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 123.45 +} +``` + + + +### DownloadableFileTypeEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | #### Example ```json -""AF"" +""FILE"" ``` -### CreateCompanyOutput +### DownloadableInvoiceItem -Contains the response to the request to create a company. +Defines downloadable product options for `InvoiceItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The new company instance. | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example ```json -{"company": Company} +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} ``` -### CreateCompanyRoleOutput +### DownloadableItemsLinks -Contains the response to the request to create a company role. +Defines characteristics of the links for downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json -{"role": CompanyRole} +{ + "sort_order": 987, + "title": "abc123", + "uid": "4" +} ``` -### CreateCompanyTeamOutput +### DownloadableOrderItem -Contains the response to the request to create a company team. +Defines downloadable product options for `OrderItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json -{"team": CompanyTeam} +{ + "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": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, + "quantity_return_requested": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} ``` -### CreateCompanyUserOutput +### DownloadableProduct -Contains the response to the request to create a company user. +Defines a product that the shopper downloads. #### Fields | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The new company user instance. | +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | +| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example ```json -{"user": Customer} +{ + "activity": "abc123", + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "xyz789", + "collar": "xyz789", + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "downloadable_product_links": [ + DownloadableProductLinks + ], + "downloadable_product_samples": [ + DownloadableProductSamples + ], + "eco_collection": 987, + "erin_recommends": 987, + "features_bags": "xyz789", + "format": 123, + "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": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "abc123", + "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": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "pattern": "abc123", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 123, + "quantity": 123.45, + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 123, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 987, + "short_description": ComplexTextValue, + "size": 123, + "sku": "xyz789", + "sleeve": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "strap_bags": "xyz789", + "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": "abc123", + "uid": 4, + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website] +} ``` -### CreateCompareListInput +### DownloadableProductCartItemInput -Contains an array of product IDs to use for creating a compare list. +Defines a single downloadable product. #### Input Fields | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | +| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | #### Example ```json -{"products": [4]} +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "downloadable_product_links": [ + DownloadableProductLinksInput + ] +} ``` -### CreateGiftRegistryInput +### DownloadableProductLinks -Defines a new gift registry. +Defines characteristics of a downloadable product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | -| `message` - [`String!`](#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| Field Name | Description | +|------------|-------------| +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](#float) | The price of the downloadable product. | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "xyz789", - "gift_registry_type_uid": 4, - "message": "abc123", - "privacy_settings": "PRIVATE", - "registrants": [AddGiftRegistryRegistrantInput], - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" + "id": 987, + "is_shareable": false, + "link_type": "FILE", + "number_of_downloads": 123, + "price": 987.65, + "sample_file": "xyz789", + "sample_type": "FILE", + "sample_url": "abc123", + "sort_order": 123, + "title": "abc123", + "uid": "4" } ``` -### CreateGiftRegistryOutput +### DownloadableProductLinksInput -Contains the results of a request to create a gift registry. +Contains the link ID for the downloadable product. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| Input Field | Description | +|-------------|-------------| +| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | #### Example ```json -{"gift_registry": GiftRegistry} +{"link_id": 123} ``` -### CreateGuestCartInput +### DownloadableProductSamples + +Defines characteristics of a downloadable product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +| Field Name | Description | +|------------|-------------| +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the sample. | #### Example ```json -{"cart_uid": "4"} +{ + "id": 123, + "sample_file": "abc123", + "sample_type": "FILE", + "sample_url": "xyz789", + "sort_order": 123, + "title": "xyz789" +} ``` -### CreateGuestCartOutput +### DownloadableRequisitionListItem + +Contains details about downloadable products added to a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The newly created cart. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json -{"cart": Cart} +{ + "customizable_options": [SelectedCustomizableOption], + "links": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples], + "uid": 4 +} ``` -### CreatePayflowProTokenOutput +### DownloadableWishlistItem -Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. +A downloadable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "response_message": "xyz789", - "result": 123, - "result_code": 123, - "secure_token": "xyz789", - "secure_token_id": "abc123" + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "links_v2": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples] } ``` -### CreatePaymentOrderInput +### DuplicateNegotiableQuoteInput -Contains payment order details that are used while processing the payment order +Identifies a quote to be duplicated #### Input Fields | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | +| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | #### Example ```json { - "cartId": "abc123", - "location": "PRODUCT_DETAIL", - "methodCode": "xyz789", - "paymentSource": "abc123", - "vaultIntent": false + "duplicated_quote_uid": 4, + "quote_uid": "4" } ``` -### CreatePaymentOrderOutput +### DuplicateNegotiableQuoteOutput -Contains payment order details that are used while processing the payment order +Contains the newly created negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](#float) | The amount of the payment order | -| `currency_code` - [`String`](#string) | The currency of the payment order | -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `status` - [`String`](#string) | The status of the payment order | +| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example ```json -{ - "amount": 987.65, - "currency_code": "xyz789", - "id": "abc123", - "mp_order_id": "abc123", - "status": "xyz789" -} +{"quote": NegotiableQuote} ``` -### CreateProductReviewInput +### DynamicBlock -Defines a new product review. +Contains a single dynamic block. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | +| Field Name | Description | +|------------|-------------| +| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | +| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json { - "nickname": "xyz789", - "ratings": [ProductReviewRatingInput], - "sku": "xyz789", - "summary": "xyz789", - "text": "xyz789" + "content": ComplexTextValue, + "uid": "4" } ``` -### CreateProductReviewOutput +### DynamicBlockLocationEnum -Contains the completed product review. +Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `CONTENT` | | +| `HEADER` | | +| `FOOTER` | | +| `LEFT` | | +| `RIGHT` | | #### Example ```json -{"review": ProductReview} +""CONTENT"" ``` -### CreatePurchaseOrderApprovalRuleConditionAmountInput +### DynamicBlockTypeEnum -Specifies the amount and currency to evaluate. +Indicates the selected Dynamic Blocks Rotator inline widget. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| Enum Value | Description | +|------------|-------------| +| `SPECIFIED` | | +| `CART_PRICE_RULE_RELATED` | | +| `CATALOG_PRICE_RULE_RELATED` | | #### Example ```json -{"currency": "AFN", "value": 123.45} +""SPECIFIED"" ``` -### CreatePurchaseOrderApprovalRuleConditionInput +### DynamicBlocks -Defines a set of conditions that apply to a rule. +Contains an array of dynamic blocks. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | -| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | #### Example ```json { - "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN", - "quantity": 987 + "items": [DynamicBlock], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### CreateRequisitionListInput +### DynamicBlocksFilterInput -An input object that identifies and describes a new requisition list. +Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | +| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | #### Example ```json -{ - "description": "abc123", - "name": "xyz789" -} +{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"} ``` -### CreateRequisitionListOutput +### EnteredCustomAttributeInput -Output of the request to create a requisition list. +Contains details about a custom text attribute that the buyer entered. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](#string) | The text or other entered value. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "attribute_code": "xyz789", + "value": "abc123" +} ``` -### CreateVaultCardPaymentTokenInput +### EnteredOptionInput -Describe the variables needed to create a vault payment token +Defines a customer-entered option. #### Input Fields | Input Field | Description | |-------------|-------------| -| `card_description` - [`String`](#string) | Description of the vaulted card | -| `setup_token_id` - [`String!`](#string) | The setup token obtained by the createVaultCardSetupToken endpoint | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](#string) | Text the customer entered. | #### Example ```json { - "card_description": "abc123", - "setup_token_id": "abc123" + "uid": "4", + "value": "xyz789" } ``` -### CreateVaultCardPaymentTokenOutput +### EntityUrl -The vault token id and information about the payment source +Contains the `uid`, `relative_url`, and `type` attributes. #### Fields | Field Name | Description | |------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](#string) | The vault payment token information | +| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | +| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json { - "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "canonical_url": "abc123", + "entity_uid": 4, + "id": 123, + "redirectCode": 123, + "relative_url": "abc123", + "type": "CMS_PAGE" } ``` -### CreateVaultCardSetupTokenInput +### Error -Describe the variables needed to create a vault card setup token +An error encountered while adding an item to the the cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | + +#### Possible Types + +| Error Types | +|----------------| +| [`CartUserInputError`](#cartuserinputerror) | +| [`InsufficientStockError`](#insufficientstockerror) | #### Example ```json { - "setup_token": VaultSetupTokenInput, - "three_ds_mode": "OFF" + "code": "PRODUCT_NOT_FOUND", + "message": "abc123" } ``` -### CreateVaultCardSetupTokenOutput - -The setup token id information +### ErrorInterface #### Fields | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](#string) | The setup token id | +| `message` - [`String!`](#string) | The returned error message. | + +#### Possible Types + +| ErrorInterface Types | +|----------------| +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | #### Example ```json -{"setup_token": "abc123"} +{"message": "abc123"} ``` -### CreateWishlistInput +### EstimateAddressInput -Defines the name and visibility of a new wish list. +Contains details about an address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `name` - [`String!`](#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example ```json -{"name": "xyz789", "visibility": "PUBLIC"} +{ + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput +} ``` -### CreateWishlistOutput - -Contains the wish list. +### EstimateTotalsInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| Input Field | Description | +|-------------|-------------| +| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | +| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example ```json -{"wishlist": Wishlist} +{ + "address": EstimateAddressInput, + "cart_id": "xyz789", + "shipping_method": ShippingMethodInput +} ``` -### CreditCardDetailsInput +### EstimateTotalsOutput -Required fields for Payflow Pro and Payments Pro credit card payments. +Estimate totals output. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](#string) | The credit card type. | +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | Cart after totals estimation | #### Example ```json -{ - "cc_exp_month": 123, - "cc_exp_year": 123, - "cc_last_4": 987, - "cc_type": "abc123" -} +{"cart": Cart} ``` -### CreditMemo +### ExchangeRate -Contains credit memo details. +Lists the exchange rate. #### Fields | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | -| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](#string) | The sequential credit memo number. | -| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | +| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | #### Example ```json -{ - "comments": [SalesCommentItem], - "id": "4", - "items": [CreditMemoItemInterface], - "number": "abc123", - "total": CreditMemoTotal -} +{"currency_to": "abc123", "rate": 123.45} ``` + +### createEmptyCartInput + +Assigns a specific `cart_id` to the empty cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String`](#string) | The ID to assign to the cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md new file mode 100644 index 000000000..9384bda55 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md @@ -0,0 +1,2518 @@ +## Types + +### FilterEqualTypeInput + +Defines a filter that matches the input exactly. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#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]`](#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 + +```json +{ + "eq": "abc123", + "in": ["xyz789"] +} +``` + + + +### FilterMatchTypeEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FULL` | | +| `PARTIAL` | | + +#### Example + +```json +""FULL"" +``` + + + +### FilterMatchTypeInput + +Defines a filter that performs a fuzzy search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `match` - [`String`](#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`](#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 + +```json +{"match": "xyz789", "match_type": "FULL"} +``` + + + +### FilterRangeTypeInput + +Defines a filter that matches a range of values, such as prices or dates. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | + +#### Example + +```json +{ + "from": "abc123", + "to": "xyz789" +} +``` + + + +### FilterStringTypeInput + +Defines a filter for an input string. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | + +#### Example + +```json +{ + "eq": "xyz789", + "in": ["xyz789"], + "match": "xyz789" +} +``` + + + +### FilterTypeInput + +Defines the comparison operators that can be used in a filter. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Equals. | +| `finset` - [`[String]`](#string) | | +| `from` - [`String`](#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](#string) | Greater than. | +| `gteq` - [`String`](#string) | Greater than or equal to. | +| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](#string) | Less than. | +| `lteq` - [`String`](#string) | Less than or equal to. | +| `moreq` - [`String`](#string) | More than or equal to. | +| `neq` - [`String`](#string) | Not equal to. | +| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](#string) | Not null. | +| `null` - [`String`](#string) | Is null. | +| `to` - [`String`](#string) | To. Must be used with the `from` field. | + +#### Example + +```json +{ + "eq": "xyz789", + "finset": ["abc123"], + "from": "abc123", + "gt": "abc123", + "gteq": "abc123", + "in": ["abc123"], + "like": "xyz789", + "lt": "abc123", + "lteq": "abc123", + "moreq": "abc123", + "neq": "abc123", + "nin": ["xyz789"], + "notnull": "abc123", + "null": "abc123", + "to": "xyz789" +} +``` + + + +### FixedProductTax + +A single FPT that can be applied to a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | + +#### Example + +```json +{ + "amount": Money, + "label": "xyz789" +} +``` + + + +### FixedProductTaxDisplaySettings + +Lists display settings for the Fixed Product Tax. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""INCLUDE_FPT_WITHOUT_DETAILS"" +``` + + + +### Float + +The `Float` scalar type represents signed double-precision fractional +values as specified by +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). + +#### Example + +```json +987.65 +``` + + + +### GenerateCustomerTokenAsAdminInput + +Identifies which customer requires remote shopping assistance. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | + +#### Example + +```json +{"customer_email": "xyz789"} +``` + + + +### GenerateCustomerTokenAsAdminOutput + +Contains the generated customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer_token` - [`String!`](#string) | The generated customer token. | + +#### Example + +```json +{"customer_token": "xyz789"} +``` + + + +### GenerateNegotiableQuoteFromTemplateInput + +Specifies the template id, from which to generate quote from. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": 4} +``` + + + +### GenerateNegotiableQuoteFromTemplateOutput + +Contains the generated negotiable quote id. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | + +#### Example + +```json +{"negotiable_quote_uid": "4"} +``` + + + +### GetPaymentSDKOutput + +Gets the payment SDK URLs and values + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | + +#### Example + +```json +{"sdkParams": [PaymentSDKParamsItem]} +``` + + + +### GiftCardAccount + +Contains details about the gift card account. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`Money`](#money) | The balance remaining on the gift card. | +| `code` - [`String`](#string) | The gift card account code. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "balance": Money, + "code": "xyz789", + "expiration_date": "xyz789" +} +``` + + + +### GiftCardAccountInput + +Contains the gift card code. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_card_code` - [`String!`](#string) | The applied gift card code. | + +#### Example + +```json +{"gift_card_code": "abc123"} +``` + + + +### GiftCardAmounts + +Contains the value of a gift card, the website that generated the card, and related information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_id` - [`Int`](#int) | An internal attribute ID. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | +| `value` - [`Float`](#float) | The value of the gift card. | +| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | +| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | +| `website_value` - [`Float`](#float) | The value of the gift card. | + +#### Example + +```json +{ + "attribute_id": 123, + "uid": 4, + "value": 123.45, + "value_id": 123, + "website_id": 123, + "website_value": 987.65 +} +``` + + + +### GiftCardCartItem + +Contains details about a gift card that has been added to a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender. | +| `sender_name` - [`String!`](#string) | The name of the sender. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "amount": Money, + "available_gift_wrapping": [GiftWrapping], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "xyz789", + "is_available": false, + "max_qty": 987.65, + "message": "abc123", + "min_qty": 123.45, + "not_available_message": "abc123", + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "recipient_email": "abc123", + "recipient_name": "abc123", + "sender_email": "abc123", + "sender_name": "abc123", + "uid": "4" +} +``` + + + +### GiftCardCreditMemoItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 +} +``` + + + +### GiftCardInvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### GiftCardItem + +Contains details about a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | + +#### Example + +```json +{ + "message": "abc123", + "recipient_email": "abc123", + "recipient_name": "xyz789", + "sender_email": "xyz789", + "sender_name": "xyz789" +} +``` + + + +### GiftCardOptions + +Contains details about the sender, recipient, and amount of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](#string) | A message to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | + +#### Example + +```json +{ + "amount": Money, + "custom_giftcard_amount": Money, + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "abc123" +} +``` + + + +### GiftCardOrderItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_card": GiftCardItem, + "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": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 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": "abc123" +} +``` + + + +### GiftCardProduct + +Defines properties of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | +| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | +| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "xyz789", + "allow_message": false, + "allow_open_amount": true, + "attribute_set_id": 123, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "abc123", + "collar": "abc123", + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "eco_collection": 123, + "erin_recommends": 987, + "features_bags": "abc123", + "format": 987, + "gender": "abc123", + "gift_card_options": [CustomizableOptionInterface], + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "giftcard_amounts": [GiftCardAmounts], + "giftcard_type": "VIRTUAL", + "id": 987, + "image": ProductImage, + "is_redeemable": false, + "is_returnable": "xyz789", + "lifetime": 123, + "manufacturer": 123, + "material": "abc123", + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "message_max_length": 987, + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", + "new": 987, + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "open_amount_max": 123.45, + "open_amount_min": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "pattern": "xyz789", + "performance_fabric": 987, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 987, + "quantity": 123.45, + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 987, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 123, + "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": "xyz789", + "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": "abc123", + "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 +} +``` + + + +### GiftCardRequisitionListItem + +Contains details about gift cards added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "gift_card_options": GiftCardOptions, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### GiftCardShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### GiftCardTypeEnum + +Specifies the gift card type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `VIRTUAL` | | +| `PHYSICAL` | | +| `COMBINED` | | + +#### Example + +```json +""VIRTUAL"" +``` + + + +### GiftCardWishlistItem + +A single gift card added to a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "gift_card_options": GiftCardOptions, + "id": "4", + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### GiftMessage + +Contains the text of a gift message, its sender, and recipient + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `from` - [`String!`](#string) | Sender name | +| `message` - [`String!`](#string) | Gift message text | +| `to` - [`String!`](#string) | Recipient name | + +#### Example + +```json +{ + "from": "abc123", + "message": "abc123", + "to": "xyz789" +} +``` + + + +### GiftMessageInput + +Defines a gift message. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String!`](#string) | The name of the sender. | +| `message` - [`String!`](#string) | The text of the gift message. | +| `to` - [`String!`](#string) | The name of the recepient. | + +#### Example + +```json +{ + "from": "xyz789", + "message": "xyz789", + "to": "abc123" +} +``` + + + +### GiftOptionsPrices + +Contains prices for gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](#money) | Price for the printed card including tax. | + +#### Example + +```json +{ + "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 +} +``` + + + +### GiftRegistry + +Contains details about a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | +| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | +| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | +| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | +| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | + +#### Example + +```json +{ + "created_at": "abc123", + "dynamic_attributes": [GiftRegistryDynamicAttribute], + "event_name": "abc123", + "items": [GiftRegistryItemInterface], + "message": "abc123", + "owner_name": "xyz789", + "privacy_settings": "PRIVATE", + "registrants": [GiftRegistryRegistrant], + "shipping_address": CustomerAddress, + "status": "ACTIVE", + "type": GiftRegistryType, + "uid": 4 +} +``` + + + +### GiftRegistryDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": "4", + "group": "EVENT_INFORMATION", + "label": "abc123", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeGroup + +Defines the group type of a gift registry dynamic attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `EVENT_INFORMATION` | | +| `PRIVACY_SETTINGS` | | +| `REGISTRANT` | | +| `GENERAL_INFORMATION` | | +| `DETAILED_INFORMATION` | | +| `SHIPPING_ADDRESS` | | + +#### Example + +```json +""EVENT_INFORMATION"" +``` + + + +### GiftRegistryDynamicAttributeInput + +Defines a dynamic attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | +| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | + +#### Example + +```json +{"code": 4, "value": "xyz789"} +``` + + + +### GiftRegistryDynamicAttributeInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Possible Types + +| GiftRegistryDynamicAttributeInterface Types | +|----------------| +| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | +| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | + +#### Example + +```json +{ + "code": "4", + "label": "xyz789", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeMetadata + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Example + +```json +{ + "attribute_group": "abc123", + "code": 4, + "input_type": "abc123", + "is_required": false, + "label": "abc123", + "sort_order": 123 +} +``` + + + +### GiftRegistryDynamicAttributeMetadataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Possible Types + +| GiftRegistryDynamicAttributeMetadataInterface Types | +|----------------| +| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | + +#### Example + +```json +{ + "attribute_group": "abc123", + "code": 4, + "input_type": "abc123", + "is_required": true, + "label": "abc123", + "sort_order": 987 +} +``` + + + +### GiftRegistryItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Example + +```json +{ + "created_at": "xyz789", + "note": "abc123", + "product": ProductInterface, + "quantity": 987.65, + "quantity_fulfilled": 123.45, + "uid": "4" +} +``` + + + +### GiftRegistryItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Possible Types + +| GiftRegistryItemInterface Types | +|----------------| +| [`GiftRegistryItem`](#giftregistryitem) | + +#### Example + +```json +{ + "created_at": "xyz789", + "note": "abc123", + "product": ProductInterface, + "quantity": 987.65, + "quantity_fulfilled": 987.65, + "uid": 4 +} +``` + + + +### GiftRegistryItemUserErrorInterface + +Contains the status and any errors that encountered with the customer's gift register item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | + +#### Possible Types + +| GiftRegistryItemUserErrorInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{ + "status": true, + "user_errors": [GiftRegistryItemsUserError] +} +``` + + + +### GiftRegistryItemsUserError + +Contains details about an error that occurred when processing a gift registry item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | +| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | +| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | +| `message` - [`String!`](#string) | A localized error message. | +| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | + +#### Example + +```json +{ + "code": "OUT_OF_STOCK", + "gift_registry_item_uid": "4", + "gift_registry_uid": 4, + "message": "xyz789", + "product_uid": "4" +} +``` + + + +### GiftRegistryItemsUserErrorType + +Defines the error type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""OUT_OF_STOCK"" +``` + + + +### GiftRegistryOutputInterface + +Contains the customer's gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | + +#### Possible Types + +| GiftRegistryOutputInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### GiftRegistryPrivacySettings + +Defines the privacy setting of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRIVATE` | | +| `PUBLIC` | | + +#### Example + +```json +""PRIVATE"" +``` + + + +### GiftRegistryRegistrant + +Contains details about a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | +| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryRegistrantDynamicAttribute + ], + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", + "uid": "4" +} +``` + + + +### GiftRegistryRegistrantDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": 4, + "label": "abc123", + "value": "abc123" +} +``` + + + +### GiftRegistrySearchResult + +Contains the results of a gift registry search. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `event_date` - [`String`](#string) | The date of the event. | +| `event_title` - [`String!`](#string) | The title given to the event. | +| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | +| `location` - [`String`](#string) | The location of the event. | +| `name` - [`String!`](#string) | The name of the gift registry owner. | +| `type` - [`String`](#string) | The type of event being held. | + +#### Example + +```json +{ + "event_date": "xyz789", + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "xyz789", + "name": "abc123", + "type": "abc123" +} +``` + + + +### GiftRegistryShippingAddressInput + +Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | + +#### Example + +```json +{ + "address_data": CustomerAddressInput, + "address_id": "4" +} +``` + + + +### GiftRegistryStatus + +Defines the status of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | + +#### Example + +```json +""ACTIVE"" +``` + + + +### GiftRegistryType + +Contains details about a gift registry type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | + +#### Example + +```json +{ + "dynamic_attributes_metadata": [ + GiftRegistryDynamicAttributeMetadataInterface + ], + "label": "abc123", + "uid": 4 +} +``` + + + +### GiftWrapping + +Contains details about the selected or available gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | +| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | +| `price` - [`Money!`](#money) | The gift wrapping price. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | + +#### Example + +```json +{ + "design": "abc123", + "id": 4, + "image": GiftWrappingImage, + "price": Money, + "uid": "4" +} +``` + + + +### GiftWrappingImage + +Points to an image associated with a gift wrapping option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The gift wrapping preview image label. | +| `url` - [`String!`](#string) | The gift wrapping preview image URL. | + +#### Example + +```json +{ + "label": "xyz789", + "url": "xyz789" +} +``` + + + +### GooglePayButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `type` - [`String`](#string) | The button type | + +#### Example + +```json +{ + "color": "xyz789", + "height": 987, + "type": "xyz789" +} +``` + + + +### GooglePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": GooglePayButtonStyles, + "code": "abc123", + "is_visible": false, + "payment_intent": "xyz789", + "payment_source": "abc123", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "three_ds_mode": "OFF", + "title": "abc123" +} +``` + + + +### GooglePayMethodInput + +Google Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### GroupedProduct + +Defines a grouped product, which consists of simple standalone products that are presented as a group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "activity": "xyz789", + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "xyz789", + "collar": "xyz789", + "color": 123, + "country_of_manufacture": "xyz789", + "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": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "id": 123, + "image": ProductImage, + "is_returnable": "xyz789", + "items": [GroupedProductItem], + "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": 123.45, + "name": "abc123", + "new": 123, + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "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": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 123, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 123, + "short_description": ComplexTextValue, + "size": 123, + "sku": "xyz789", + "sleeve": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": true, + "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": "abc123", + "uid": 4, + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### GroupedProductItem + +Contains information about an individual grouped product item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | +| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | +| `qty` - [`Float`](#float) | The quantity of this grouped product item. | + +#### Example + +```json +{ + "position": 123, + "product": ProductInterface, + "qty": 987.65 +} +``` + + + +### GroupedProductWishlistItem + +A grouped product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### GuestOrderCancelInput + +Input to retrieve a guest order based on token. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `reason` - [`String!`](#string) | Cancellation reason. | +| `token` - [`String!`](#string) | Order token. | + +#### Example + +```json +{ + "reason": "xyz789", + "token": "xyz789" +} +``` + + + +### HostedFieldsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cc_vault_code` - [`String`](#string) | Vault payment method code | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "cc_vault_code": "abc123", + "code": "xyz789", + "is_vault_enabled": true, + "is_visible": false, + "payment_intent": "xyz789", + "payment_source": "abc123", + "requires_card_details": false, + "sdk_params": [SDKParams], + "sort_order": "abc123", + "three_ds": false, + "three_ds_mode": "OFF", + "title": "xyz789" +} +``` + + + +### HostedFieldsInput + +Hosted Fields payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cardBin` - [`String`](#string) | Card bin number | +| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | +| `cardLast4` - [`String`](#string) | Last four digits of the card | +| `holderName` - [`String`](#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cardBin": "abc123", + "cardExpiryMonth": "abc123", + "cardExpiryYear": "xyz789", + "cardLast4": "abc123", + "holderName": "xyz789", + "is_active_payment_token_enabler": false, + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### HostedProInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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 + +```json +{ + "cancel_url": "xyz789", + "return_url": "xyz789" +} +``` + + + +### HostedProUrl + +Contains the secure URL used for the Payments Pro Hosted Solution payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | + +#### Example + +```json +{"secure_form_url": "abc123"} +``` + + + +### HostedProUrlInput + +Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### HttpQueryParameter + +Contains target path parameters. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | A parameter name. | +| `value` - [`String`](#string) | A parameter value. | + +#### Example + +```json +{ + "name": "xyz789", + "value": "xyz789" +} +``` + + + +### ID + +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 + +```json +"4" +``` + + + +### ImageSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{ + "thumbnail": "xyz789", + "value": "abc123" +} +``` + + + +### InputFilterEnum + +List of templates/filters applied to customer attribute input. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""NONE"" +``` + + + +### InsufficientStockError + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | +| `quantity` - [`Float`](#float) | Amount of available stock | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789", + "quantity": 987.65 +} +``` + + + +### Int + +The `Int` scalar type represents non-fractional signed whole numeric +values. Int can represent values between -(2^31) and 2^31 - 1. + +#### Example + +```json +123 +``` + + + +### InternalError + +Contains an error message when an internal error occurred. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | + +#### Example + +```json +{"message": "xyz789"} +``` + + + +### Invoice + +Contains invoice details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | +| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | +| `number` - [`String!`](#string) | Sequential invoice number. | +| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "id": 4, + "items": [InvoiceItemInterface], + "number": "abc123", + "total": InvoiceTotal +} +``` + + + +### InvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### InvoiceItemInterface + +Contains detailes about invoiced items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Possible Types + +| InvoiceItemInterface Types | +|----------------| +| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | +| [`InvoiceItem`](#invoiceitem) | + +#### Example + +```json +{ + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 987.65 +} +``` + + + +### InvoiceTotal + +Contains price details from an invoice. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | + +#### Example + +```json +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money +} +``` + + + +### IsCompanyAdminEmailAvailableOutput + +Contains the response of a company admin email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsCompanyEmailAvailableOutput + +Contains the response of a company email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsCompanyRoleNameAvailableOutput + +Contains the response of a role name validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | + +#### Example + +```json +{"is_role_name_available": true} +``` + + + +### IsCompanyUserEmailAvailableOutput + +Contains the response of a company user email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsEmailAvailableOutput + +Contains the result of the `isEmailAvailable` query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### ItemNote + +The note object for quote line item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | +| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | +| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | +| `note` - [`String`](#string) | Note text. | +| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | + +#### Example + +```json +{ + "created_at": "abc123", + "creator_id": 987, + "creator_type": 987, + "negotiable_quote_item_uid": "4", + "note": "abc123", + "note_uid": "4" +} +``` + + + +### ItemSelectedBundleOption + +A list of options of the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String!`](#string) | The label of the option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | +| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | + +#### Example + +```json +{ + "id": "4", + "label": "abc123", + "uid": 4, + "values": [ItemSelectedBundleOptionValue] +} +``` + + + +### ItemSelectedBundleOptionValue + +A list of values for the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | +| `price` - [`Money!`](#money) | The price of the child bundle product. | +| `product_name` - [`String!`](#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | +| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | + +#### Example + +```json +{ + "id": 4, + "price": Money, + "product_name": "xyz789", + "product_sku": "abc123", + "quantity": 123.45, + "uid": "4" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-3.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md similarity index 62% rename from src/pages/includes/autogenerated/graphql-api-2-4-8-types-3.md rename to src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md index daf033c01..b5b73b13c 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-3.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-k-p.md @@ -1,4839 +1,2133 @@ -### NegotiableQuote +## Types -Contains details about a negotiable quote. +### KeyValue + +Contains a key-value pair. #### Fields | Field Name | Description | |------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | -| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](#string) | The email address of the company user. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | -| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | +| `name` - [`String`](#string) | The name part of the key/value pair. | +| `value` - [`String`](#string) | The value part of the key/value pair. | #### Example ```json { - "available_payment_methods": [AvailablePaymentMethod], - "billing_address": NegotiableQuoteBillingAddress, - "buyer": NegotiableQuoteUser, - "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "email": "abc123", - "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, - "items": [CartItemInterface], "name": "abc123", - "prices": CartPrices, - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "SUBMITTED", - "total_quantity": 987.65, - "uid": 4, - "updated_at": "xyz789" + "value": "xyz789" } ``` -### NegotiableQuoteAddressCountry +### LayerFilter -Defines the company's country. +Contains information for rendering layered navigation. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | +| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | +| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example ```json { - "code": "abc123", - "label": "abc123" + "filter_items": [LayerFilterItemInterface], + "filter_items_count": 987, + "name": "abc123", + "request_var": "xyz789" } ``` -### NegotiableQuoteAddressInput - -Defines the billing or shipping address to be applied to the cart. +### LayerFilterItem -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company name. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| Field Name | Description | +|------------|-------------| +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example ```json { - "city": "xyz789", - "company": "xyz789", - "country_code": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", - "postcode": "abc123", - "region": "xyz789", - "region_id": 123, - "save_in_address_book": false, - "street": ["xyz789"], - "telephone": "abc123" + "items_count": 987, + "label": "xyz789", + "value_string": "abc123" } ``` -### NegotiableQuoteAddressInterface +### LayerFilterItemInterface #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Possible Types -| NegotiableQuoteAddressInterface Types | +| LayerFilterItemInterface Types | |----------------| -| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | -| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | +| [`LayerFilterItem`](#layerfilteritem) | +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | #### Example ```json { - "city": "xyz789", - "company": "abc123", - "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" + "items_count": 987, + "label": "xyz789", + "value_string": "xyz789" } ``` -### NegotiableQuoteAddressRegion +### LineItemNoteInput -Defines the company's state or province. +Sets quote item note. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The address region code. | -| `label` - [`String`](#string) | The display name of the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| Input Field | Description | +|-------------|-------------| +| `note` - [`String`](#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "code": "abc123", - "label": "abc123", - "region_id": 987 + "note": "abc123", + "quote_item_uid": 4, + "quote_uid": 4 } ``` -### NegotiableQuoteBillingAddress +### MediaGalleryEntry + +Defines characteristics about images and videos associated with a specific product. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | +| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](#string) | The path of the image on the server. | +| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](#string) | Either `image` or `video`. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example ```json { - "city": "abc123", - "company": "abc123", - "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" + "content": ProductMediaGalleryEntriesContent, + "disabled": true, + "file": "xyz789", + "id": 123, + "label": "xyz789", + "media_type": "xyz789", + "position": 123, + "types": ["abc123"], + "uid": 4, + "video_content": ProductMediaGalleryEntriesVideoContent } ``` -### NegotiableQuoteBillingAddressInput +### MediaGalleryInterface -Defines the billing address. +Contains basic information about a product image or video. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| Field Name | Description | +|------------|-------------| +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Possible Types + +| MediaGalleryInterface Types | +|----------------| +| [`ProductImage`](#productimage) | +| [`ProductVideo`](#productvideo) | #### Example ```json { - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "same_as_shipping": true, - "use_for_shipping": true + "disabled": false, + "label": "abc123", + "position": 987, + "url": "abc123" } ``` -### NegotiableQuoteComment - -Contains a single plain text comment from either the buyer or seller. +### MessageStyleLogo #### Fields | Field Name | Description | |------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | -| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](#string) | The plain text comment. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | +| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{ - "author": NegotiableQuoteUser, - "created_at": "abc123", - "creator_type": "BUYER", - "text": "xyz789", - "uid": 4 -} +{"type": "abc123"} ``` -### NegotiableQuoteCommentCreatorType +### MessageStyles -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `BUYER` | | -| `SELLER` | | +| `layout` - [`String`](#string) | The message layout | +| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json -""BUYER"" +{ + "layout": "abc123", + "logo": MessageStyleLogo +} ``` -### NegotiableQuoteCommentInput +### Money -Contains the commend provided by the buyer. +Defines a monetary value, including a numeric value and a currency code. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | +| Field Name | Description | +|------------|-------------| +| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](#float) | A number expressing a monetary value. | #### Example ```json -{"comment": "xyz789"} +{"currency": "AFN", "value": 987.65} ``` -### NegotiableQuoteCustomLogChange +### MoveCartItemsToGiftRegistryOutput -Contains custom log entries added by third-party extensions. +Contains the customer's gift registry and any errors encountered. #### Fields | Field Name | Description | |------------|-------------| -| `new_value` - [`String!`](#string) | The new entry content. | -| `old_value` - [`String`](#string) | The previous entry in the custom log. | -| `title` - [`String!`](#string) | The title of the custom log entry. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example ```json { - "new_value": "xyz789", - "old_value": "xyz789", - "title": "xyz789" + "gift_registry": GiftRegistry, + "status": true, + "user_errors": [GiftRegistryItemsUserError] } ``` -### NegotiableQuoteFilterInput +### MoveItemsBetweenRequisitionListsInput -Defines a filter to limit the negotiable quotes to return. +An input object that defines the items in a requisition list to be moved. #### Input Fields | Input Field | Description | |-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{ - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput -} +{"requisitionListItemUids": [4]} ``` -### NegotiableQuoteHistoryChanges +### MoveItemsBetweenRequisitionListsOutput -Contains a list of changes to a negotiable quote. +Output of the request to move items to another requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | +| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | #### Example ```json { - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange + "destination_requisition_list": RequisitionList, + "source_requisition_list": RequisitionList } ``` -### NegotiableQuoteHistoryCommentChange +### MoveLineItemToRequisitionListInput -Contains a comment submitted by a seller or buyer. +Move Line Item to Requisition List. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| Input Field | Description | +|-------------|-------------| +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | #### Example ```json -{"comment": "xyz789"} +{ + "quote_item_uid": 4, + "quote_uid": 4, + "requisition_list_uid": "4" +} ``` -### NegotiableQuoteHistoryEntry +### MoveLineItemToRequisitionListOutput -Contains details about a change for a negotiable quote. +Contains the updated negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | -| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | -| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | #### Example ```json -{ - "author": NegotiableQuoteUser, - "change_type": "CREATED", - "changes": NegotiableQuoteHistoryChanges, - "created_at": "xyz789", - "uid": 4 -} +{"quote": NegotiableQuote} ``` -### NegotiableQuoteHistoryEntryChangeType +### MoveProductsBetweenWishlistsOutput -#### Values +Contains the source and target wish lists after moving products. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `CREATED` | | -| `UPDATED` | | -| `CLOSED` | | -| `UPDATED_BY_SYSTEM` | | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example ```json -""CREATED"" +{ + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] +} ``` -### NegotiableQuoteHistoryExpirationChange +### NegotiableQuote -Contains a new expiration date and the previous date. +Contains details about a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](#string) | The email address of the company user. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | +| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | #### Example ```json { - "new_expiration": "abc123", - "old_expiration": "xyz789" + "available_payment_methods": [AvailablePaymentMethod], + "billing_address": NegotiableQuoteBillingAddress, + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "created_at": "abc123", + "email": "xyz789", + "history": [NegotiableQuoteHistoryEntry], + "is_virtual": true, + "items": [CartItemInterface], + "name": "abc123", + "prices": CartPrices, + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [NegotiableQuoteShippingAddress], + "status": "SUBMITTED", + "total_quantity": 987.65, + "uid": "4", + "updated_at": "xyz789" } ``` -### NegotiableQuoteHistoryProductsRemovedChange +### NegotiableQuoteAddressCountry -Contains lists of products that have been removed from the catalog and negotiable quote. +Defines the company's country. #### Fields | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | -| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | +| `code` - [`String!`](#string) | The address country code. | +| `label` - [`String!`](#string) | The display name of the region. | #### Example ```json { - "products_removed_from_catalog": ["4"], - "products_removed_from_quote": [ProductInterface] + "code": "abc123", + "label": "abc123" } ``` -### NegotiableQuoteHistoryStatusChange +### NegotiableQuoteAddressInput -Lists a new status change applied to a negotiable quote and the previous status. +Defines the billing or shipping address to be applied to the cart. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | -| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company name. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | #### Example ```json -{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} +{ + "city": "abc123", + "company": "xyz789", + "country_code": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "abc123", + "region": "xyz789", + "region_id": 123, + "save_in_address_book": true, + "street": ["abc123"], + "telephone": "xyz789" +} ``` -### NegotiableQuoteHistoryStatusesChange - -Contains a list of status changes that occurred for the negotiable quote. +### NegotiableQuoteAddressInterface #### Fields | Field Name | Description | |------------|-------------| -| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | + +#### Possible Types + +| NegotiableQuoteAddressInterface Types | +|----------------| +| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | +| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | #### Example ```json -{"changes": [NegotiableQuoteHistoryStatusChange]} +{ + "city": "abc123", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "street": ["xyz789"], + "telephone": "abc123" +} ``` -### NegotiableQuoteHistoryTotalChange +### NegotiableQuoteAddressRegion -Contains a new price and the previous price. +Defines the company's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `new_price` - [`Money`](#money) | The total price as a result of the change. | -| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | +| `code` - [`String`](#string) | The address region code. | +| `label` - [`String`](#string) | The display name of the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "new_price": Money, - "old_price": Money + "code": "abc123", + "label": "abc123", + "region_id": 123 } ``` -### NegotiableQuoteInvalidStateError - -An error indicating that an operation was attempted on a negotiable quote in an invalid state. +### NegotiableQuoteBillingAddress #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | #### Example ```json -{"message": "xyz789"} +{ + "city": "xyz789", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "firstname": "abc123", + "lastname": "abc123", + "postcode": "xyz789", + "region": NegotiableQuoteAddressRegion, + "street": ["abc123"], + "telephone": "abc123" +} ``` -### NegotiableQuoteItemQuantityInput +### NegotiableQuoteBillingAddressInput -Specifies the updated quantity of an item. +Defines the billing address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example ```json -{"quantity": 987.65, "quote_item_uid": 4} +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "same_as_shipping": false, + "use_for_shipping": false +} ``` -### NegotiableQuotePaymentMethodInput +### NegotiableQuoteComment -Defines the payment method to be applied to the negotiable quote. +Contains a single plain text comment from either the buyer or seller. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | +| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | +| `text` - [`String!`](#string) | The plain text comment. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { - "code": "abc123", - "purchase_order_number": "xyz789" + "author": NegotiableQuoteUser, + "created_at": "xyz789", + "creator_type": "BUYER", + "text": "xyz789", + "uid": "4" } ``` -### NegotiableQuoteReferenceDocumentLink - -Contains a reference document link for a negotiable quote template. +### NegotiableQuoteCommentCreatorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `document_identifier` - [`String`](#string) | The identifier of the reference document. | -| `document_name` - [`String!`](#string) | The title of the reference document. | -| `link_id` - [`ID!`](#id) | The unique ID of a reference document link. | -| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | +| `BUYER` | | +| `SELLER` | | #### Example ```json -{ - "document_identifier": "xyz789", - "document_name": "xyz789", - "link_id": 4, - "reference_document_url": "xyz789" -} +""BUYER"" ``` -### NegotiableQuoteShippingAddress +### NegotiableQuoteCommentInput -#### Fields +Contains the commend provided by the buyer. -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The comment provided by the buyer. | #### Example ```json -{ - "available_shipping_methods": [AvailableShippingMethod], - "city": "abc123", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "abc123", - "postcode": "abc123", - "region": NegotiableQuoteAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "telephone": "abc123" -} +{"comment": "abc123"} ``` -### NegotiableQuoteShippingAddressInput +### NegotiableQuoteCustomLogChange -Defines shipping addresses for the negotiable quote. +Contains custom log entries added by third-party extensions. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | +| Field Name | Description | +|------------|-------------| +| `new_value` - [`String!`](#string) | The new entry content. | +| `old_value` - [`String`](#string) | The previous entry in the custom log. | +| `title` - [`String!`](#string) | The title of the custom log entry. | #### Example ```json { - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "abc123" + "new_value": "xyz789", + "old_value": "abc123", + "title": "xyz789" } ``` -### NegotiableQuoteSortInput +### NegotiableQuoteFilterInput -Defines the field to use to sort a list of negotiable quotes. +Defines a filter to limit the negotiable quotes to return. #### Input Fields | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example ```json -{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} +{ + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput +} ``` -### NegotiableQuoteSortableField +### NegotiableQuoteHistoryChanges -#### Values +Contains a list of changes to a negotiable quote. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `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. | +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | #### Example ```json -""QUOTE_NAME"" +{ + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange +} ``` -### NegotiableQuoteStatus +### NegotiableQuoteHistoryCommentChange + +Contains a comment submitted by a seller or buyer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | + +#### Example + +```json +{"comment": "abc123"} +``` + + + +### NegotiableQuoteHistoryEntry + +Contains details about a change for a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | +| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | +| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | + +#### Example + +```json +{ + "author": NegotiableQuoteUser, + "change_type": "CREATED", + "changes": NegotiableQuoteHistoryChanges, + "created_at": "xyz789", + "uid": 4 +} +``` + + + +### NegotiableQuoteHistoryEntryChangeType #### Values | Enum Value | Description | |------------|-------------| -| `SUBMITTED` | | -| `PENDING` | | +| `CREATED` | | | `UPDATED` | | -| `OPEN` | | -| `ORDERED` | | | `CLOSED` | | -| `DECLINED` | | -| `EXPIRED` | | -| `DRAFT` | | +| `UPDATED_BY_SYSTEM` | | #### Example ```json -""SUBMITTED"" +""CREATED"" ``` -### NegotiableQuoteTemplate +### NegotiableQuoteHistoryExpirationChange -Contains details about a negotiable quote template. +Contains a new expiration date and the previous date. #### Fields | Field Name | Description | |------------|-------------| -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteReferenceDocumentLink]`](#negotiablequotereferencedocumentlink) | A list of reference document links for the negotiable quote template. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | +| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "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": "abc123", - "notifications": [QuoteTemplateNotificationMessage], - "prices": CartPrices, - "reference_document_links": [ - NegotiableQuoteReferenceDocumentLink - ], - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "abc123", - "template_id": 4, - "total_quantity": 987.65 + "new_expiration": "xyz789", + "old_expiration": "abc123" } ``` -### NegotiableQuoteTemplateFilterInput +### NegotiableQuoteHistoryProductsRemovedChange -Defines a filter to limit the negotiable quotes to return. +Contains lists of products that have been removed from the catalog and negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | +| Field Name | Description | +|------------|-------------| +| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | #### Example ```json { - "state": FilterEqualTypeInput, - "status": FilterEqualTypeInput + "products_removed_from_catalog": ["4"], + "products_removed_from_quote": [ProductInterface] } ``` -### NegotiableQuoteTemplateGridItem +### NegotiableQuoteHistoryStatusChange -Contains data for a negotiable quote template in a grid. +Lists a new status change applied to a negotiable quote and the previous status. #### Fields | Field Name | Description | |------------|-------------| -| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `state` - [`String!`](#string) | State of the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | +| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json -{ - "activated_at": "abc123", - "company_name": "abc123", - "expiration_date": "abc123", - "is_min_max_qty_used": false, - "last_shared_at": "xyz789", - "max_order_commitment": 987, - "min_negotiated_grand_total": 123.45, - "min_order_commitment": 987, - "name": "xyz789", - "orders_placed": 123, - "sales_rep_name": "abc123", - "state": "abc123", - "status": "abc123", - "submitted_by": "xyz789", - "template_id": 4 -} +{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} ``` -### NegotiableQuoteTemplateItemQuantityInput +### NegotiableQuoteHistoryStatusesChange -Specifies the updated quantity of an item. +Contains a list of status changes that occurred for the negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | +| Field Name | Description | +|------------|-------------| +| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | #### Example ```json -{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65} +{"changes": [NegotiableQuoteHistoryStatusChange]} ``` -### NegotiableQuoteTemplateReferenceDocumentLinkInput +### NegotiableQuoteHistoryTotalChange -Defines the reference document link to add to a negotiable quote template. +Contains a new price and the previous price. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `document_identifier` - [`String`](#string) | The identifier of the reference document. | -| `document_name` - [`String!`](#string) | The title of the reference document. | -| `link_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | -| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | +| Field Name | Description | +|------------|-------------| +| `new_price` - [`Money`](#money) | The total price as a result of the change. | +| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | #### Example ```json { - "document_identifier": "abc123", - "document_name": "abc123", - "link_id": 4, - "reference_document_url": "xyz789" + "new_price": Money, + "old_price": Money } ``` -### NegotiableQuoteTemplateShippingAddressInput +### NegotiableQuoteInvalidStateError -Defines shipping addresses for the negotiable quote template. +An error indicating that an operation was attempted on a negotiable quote in an invalid state. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | #### Example ```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "abc123" -} +{"message": "abc123"} ``` -### NegotiableQuoteTemplateSortInput +### NegotiableQuoteItemQuantityInput -Defines the field to use to sort a list of negotiable quotes. +Specifies the updated quantity of an item. #### Input Fields | Input Field | Description | |-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | +| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} +{"quantity": 123.45, "quote_item_uid": 4} ``` -### NegotiableQuoteTemplateSortableField +### NegotiableQuotePaymentMethodInput -#### Values +Defines the payment method to be applied to the negotiable quote. -| Enum Value | Description | -|------------|-------------| -| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | -| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`String!`](#string) | Payment method code | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json -""TEMPLATE_ID"" +{ + "code": "abc123", + "purchase_order_number": "abc123" +} ``` -### NegotiableQuoteTemplatesOutput +### NegotiableQuoteReferenceDocumentLink -Contains a list of negotiable templates that match the specified filter. +Contains a reference document link for a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | - -#### Example - -```json -{ - "items": [NegotiableQuoteTemplateGridItem], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 123 -} -``` - - - -### NegotiableQuoteUidNonFatalResultInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Possible Types - -| NegotiableQuoteUidNonFatalResultInterface Types | -|----------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### NegotiableQuoteUidOperationSuccess - -Contains details about a successful operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### NegotiableQuoteUser - -A limited view of a Buyer or Seller in the negotiable quote process. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | - -#### Example - -```json -{ - "firstname": "xyz789", - "lastname": "abc123" -} -``` - - - -### NegotiableQuotesOutput - -Contains a list of negotiable that match the specified filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | - -#### Example - -```json -{ - "items": [NegotiableQuote], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 987 -} -``` - - - -### NoSuchEntityUidError - -Contains an error message when an invalid UID was specified. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | - -#### Example - -```json -{"message": "abc123", "uid": 4} -``` - - - -### OpenNegotiableQuoteTemplateInput - -Specifies the quote template id to open quote template. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### Order - -Contains the order ID. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | - -#### Example - -```json -{ - "order_id": "xyz789", - "order_number": "xyz789" -} -``` - - - -### OrderActionType - -The list of available order actions. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REORDER` | | -| `CANCEL` | | -| `RETURN` | | - -#### Example - -```json -""REORDER"" -``` - - - -### OrderAddress - -Contains detailed information about an order's billing and shipping addresses. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `fax` - [`String`](#string) | The fax number. | -| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | The state or province name. | -| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "abc123", - "country_code": "AF", - "custom_attributesV2": [AttributeValueInterface], - "fax": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", - "region": "xyz789", - "region_id": 4, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" -} -``` - - - -### OrderCustomerInfo - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `firstname` - [`String!`](#string) | First name of the customer | -| `lastname` - [`String`](#string) | Last name of the customer | -| `middlename` - [`String`](#string) | Middle name of the customer | -| `prefix` - [`String`](#string) | Prefix of the customer | -| `suffix` - [`String`](#string) | Suffix of the customer | - -#### Example - -```json -{ - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "prefix": "xyz789", - "suffix": "abc123" -} -``` - - - -### OrderInformationInput - -Input to retrieve an order based on details. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `lastname` - [`String!`](#string) | Order billing address lastname. | -| `number` - [`String!`](#string) | Order number. | - -#### Example - -```json -{ - "email": "xyz789", - "lastname": "xyz789", - "number": "abc123" -} -``` - - - -### OrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "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": "xyz789", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "abc123" -} -``` - - - -### OrderItemInterface - -Order item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Possible Types - -| OrderItemInterface Types | -|----------------| -| [`ConfigurableOrderItem`](#configurableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | -| [`OrderItem`](#orderitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "4", - "prices": OrderItemPrices, - "product": ProductInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 123.45, - "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" -} -``` - - - -### OrderItemOption - -Represents order item options like selected or entered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | - -#### Example - -```json -{ - "label": "abc123", - "value": "abc123" -} -``` - - - -### OrderItemPrices - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | -| `original_price` - [`Money`](#money) | The original price of the item. | -| `original_price_including_tax` - [`Money`](#money) | The original price of the item including tax. | -| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | -| `original_row_total_including_tax` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item including tax. | -| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money!`](#money) | The total of all discounts applied to the item. | - -#### Example - -```json -{ - "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 -} -``` - - - -### OrderPaymentMethod - -Contains details about the payment method used to pay for the order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](#string) | The label that describes the payment method. | -| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | - -#### Example - -```json -{ - "additional_data": [KeyValue], - "name": "abc123", - "type": "xyz789" -} -``` - - - -### OrderShipment - -Contains order shipment details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": "4", - "items": [ShipmentItemInterface], - "number": "xyz789", - "tracking": [ShipmentTracking] -} -``` - - - -### OrderTokenInput - -Input to retrieve an order based on token. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{"token": "xyz789"} -``` - - - -### OrderTotal - -Contains details about the sales total amounts used to calculate the final price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | -| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. *(Deprecated: Use subtotal_excl_tax field instead)* | -| `subtotal_excl_tax` - [`Money!`](#money) | The subtotal of the order, excluding taxes. | -| `subtotal_incl_tax` - [`Money!`](#money) | The subtotal of the order, including taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | -| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | -| `total_reward_points` - [`Money`](#money) | The total reward points applied to the order. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | -| `total_store_credit` - [`Money`](#money) | The total store credit applied to the order. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "gift_options": GiftOptionsPrices, - "grand_total": 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 -} -``` - - - -### PayflowExpressInput - -Contains required input for Payflow Express Checkout payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | - -#### Example - -```json -{ - "payer_id": "xyz789", - "token": "xyz789" -} -``` - - - -### PayflowLinkInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "error_url": "xyz789", - "return_url": "abc123" -} -``` - - - -### PayflowLinkMode - -Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TEST` | | -| `LIVE` | | - -#### Example - -```json -""TEST"" -``` - - - -### PayflowLinkToken - -Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | - -#### Example - -```json -{ - "mode": "TEST", - "paypal_url": "xyz789", - "secure_token": "abc123", - "secure_token_id": "xyz789" -} -``` - - - -### PayflowLinkTokenInput - -Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PayflowProInput - -Contains input for the Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](#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 - -```json -{ - "cc_details": CreditCardDetailsInput, - "is_active_payment_token_enabler": false -} -``` - - - -### PayflowProResponseInput - -Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | - -#### Example - -```json -{ - "cart_id": "abc123", - "paypal_payload": "xyz789" -} -``` - - - -### PayflowProResponseOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### PayflowProTokenInput - -Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | - -#### Example - -```json -{ - "cart_id": "abc123", - "urls": PayflowProUrlInput -} -``` - - - -### PayflowProUrlInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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 - -```json -{ - "cancel_url": "abc123", - "error_url": "abc123", - "return_url": "xyz789" -} -``` - - - -### PaymentConfigItem - -Contains payment fields that are common to all types of payment methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Possible Types - -| PaymentConfigItem Types | -|----------------| -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | -| [`ApplePayConfig`](#applepayconfig) | -| [`GooglePayConfig`](#googlepayconfig) | - -#### Example - -```json -{ - "code": "abc123", - "is_visible": false, - "payment_intent": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" -} -``` - - - -### PaymentConfigOutput - -Retrieves the payment configuration for a given location - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | -| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | - -#### Example - -```json -{ - "apple_pay": ApplePayConfig, - "google_pay": GooglePayConfig, - "hosted_fields": HostedFieldsConfig, - "smart_buttons": SmartButtonsConfig -} -``` - - - -### PaymentLocation - -Defines the origin location for that payment request - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_DETAIL` | | -| `MINICART` | | -| `CART` | | -| `CHECKOUT` | | -| `ADMIN` | | - -#### Example - -```json -""PRODUCT_DETAIL"" -``` - - - -### PaymentMethodInput - -Defines the payment method. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `braintree` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_ach_direct_debit` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_applepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | -| `braintree_googlepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_paypal` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_paypal_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `code` - [`String!`](#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | -| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | -| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | -| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | -| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | -| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | - -#### Example - -```json -{ - "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_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" -} -``` - - - -### PaymentOrderOutput - -Contains the payment order details - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](#string) | The status of the payment order | - -#### Example - -```json -{ - "id": "abc123", - "mp_order_id": "xyz789", - "payment_source_details": PaymentSourceDetails, - "status": "xyz789" -} -``` - - - -### PaymentSDKParamsItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | - -#### Example - -```json -{ - "code": "xyz789", - "params": [SDKParams] -} -``` - - - -### PaymentSourceDetails - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | - -#### Example - -```json -{"card": Card} -``` - - - -### PaymentSourceInput - -The payment source information - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | - -#### Example - -```json -{"card": CardPaymentSourceInput} -``` - - - -### PaymentSourceOutput - -The payment source information - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | - -#### Example - -```json -{"card": CardPaymentSourceOutput} -``` - - - -### PaymentToken - -The stored payment method available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `details` - [`String`](#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](#string) | The public hash of the token. | -| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | - -#### Example - -```json -{ - "details": "abc123", - "payment_method_code": "abc123", - "public_hash": "xyz789", - "type": "card" -} -``` - - - -### PaymentTokenTypeEnum - -The list of available payment token types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | -| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | - -#### Example - -```json -""card"" -``` - - - -### PaypalExpressInput - -Contains required input for Express Checkout and Payments Standard payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | - -#### Example - -```json -{ - "payer_id": "xyz789", - "token": "xyz789" -} -``` - - - -### PaypalExpressTokenInput - -Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](#string) | The payment method code. | -| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | -| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | -| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | - -#### Example - -```json -{ - "cart_id": "abc123", - "code": "abc123", - "express_button": false, - "urls": PaypalExpressUrlsInput, - "use_paypal_credit": true -} -``` - - - -### PaypalExpressTokenOutput - -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 Name | Description | -|------------|-------------| -| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](#string) | The token returned by PayPal. | - -#### Example - -```json -{ - "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" -} -``` - - - -### PaypalExpressUrlList - -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 Name | Description | -|------------|-------------| -| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](#string) | The URL to the PayPal login page. | - -#### Example - -```json -{ - "edit": "xyz789", - "start": "abc123" -} -``` - - - -### PaypalExpressUrlsInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 - -```json -{ - "cancel_url": "abc123", - "pending_url": "xyz789", - "return_url": "abc123", - "success_url": "abc123" -} -``` - - - -### PhysicalProductInterface - -Contains attributes specific to tangible products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Possible Types - -| PhysicalProductInterface Types | -|----------------| -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | - -#### Example - -```json -{"weight": 123.45} -``` - - - -### PickupLocation - -Defines Pickup Location information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | | -| `contact_name` - [`String`](#string) | | -| `country_id` - [`String`](#string) | | -| `description` - [`String`](#string) | | -| `email` - [`String`](#string) | | -| `fax` - [`String`](#string) | | -| `latitude` - [`Float`](#float) | | -| `longitude` - [`Float`](#float) | | -| `name` - [`String`](#string) | | -| `phone` - [`String`](#string) | | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | | -| `region` - [`String`](#string) | | -| `region_id` - [`Int`](#int) | | -| `street` - [`String`](#string) | | - -#### Example - -```json -{ - "city": "xyz789", - "contact_name": "abc123", - "country_id": "xyz789", - "description": "abc123", - "email": "xyz789", - "fax": "abc123", - "latitude": 987.65, - "longitude": 123.45, - "name": "xyz789", - "phone": "abc123", - "pickup_location_code": "xyz789", - "postcode": "xyz789", - "region": "xyz789", - "region_id": 123, - "street": "abc123" -} -``` - - - -### PickupLocationFilterInput - -PickupLocationFilterInput defines the list of attributes and filters for the search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | - -#### Example - -```json -{ - "city": FilterTypeInput, - "country_id": FilterTypeInput, - "name": FilterTypeInput, - "pickup_location_code": FilterTypeInput, - "postcode": FilterTypeInput, - "region": FilterTypeInput, - "region_id": FilterTypeInput, - "street": FilterTypeInput -} -``` - - - -### PickupLocationSortInput - -PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | -| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | - -#### Example - -```json -{ - "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" -} -``` - - - -### PickupLocations - -Top level object returned in a pickup locations search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](#int) | The number of products returned. | - -#### Example - -```json -{ - "items": [PickupLocation], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### PlaceNegotiableQuoteOrderInput - -Specifies the negotiable quote to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_uid": 4} -``` - - - -### PlaceNegotiableQuoteOrderOutput - -An output object that returns the generated order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`Order!`](#order) | Contains the generated order number. | - -#### Example - -```json -{"order": Order} -``` - - - -### PlaceOrderError - -An error encountered while placing an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Example - -```json -{ - "code": "CART_NOT_FOUND", - "message": "abc123" -} -``` - - - -### PlaceOrderErrorCodes - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CART_NOT_FOUND` | | -| `CART_NOT_ACTIVE` | | -| `GUEST_EMAIL_MISSING` | | -| `UNABLE_TO_PLACE_ORDER` | | -| `UNDEFINED` | | - -#### Example - -```json -""CART_NOT_FOUND"" -``` - - - -### PlaceOrderForPurchaseOrderInput - -Specifies the purchase order to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | - -#### Example - -```json -{"purchase_order_uid": "4"} -``` - - - -### PlaceOrderForPurchaseOrderOutput - -Contains the results of the request to place an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | - -#### Example - -```json -{"order": CustomerOrder} -``` - - - -### PlaceOrderInput - -Specifies the quote to be converted to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### PlaceOrderOutput - -Contains the results of the request to place an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | -| `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | -| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | - -#### Example - -```json -{ - "errors": [PlaceOrderError], - "order": Order, - "orderV2": CustomerOrder -} -``` - - - -### PlacePurchaseOrderInput - -Specifies the quote to be converted to a purchase order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PlacePurchaseOrderOutput - -Contains the results of the request to place a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | - -#### Example - -```json -{"purchase_order": PurchaseOrder} -``` - - - -### Price - -Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | -| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | - -#### Example - -```json -{ - "adjustments": [PriceAdjustment], - "amount": Money -} -``` - - - -### PriceAdjustment - -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 Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | -| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | -| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | - -#### Example - -```json -{ - "amount": Money, - "code": "TAX", - "description": "INCLUDED" -} -``` - - - -### PriceAdjustmentCodesEnum - -`PriceAdjustment.code` is deprecated. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | -| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | -| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | - -#### Example - -```json -""TAX"" -``` - - - -### PriceAdjustmentDescriptionEnum - -`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INCLUDED` | | -| `EXCLUDED` | | - -#### Example - -```json -""INCLUDED"" -``` - - - -### PriceDetails - -Can be used to retrieve the main price details in case of bundle product - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](#float) | The regular price of the main product | - -#### Example - -```json -{ - "discount_percentage": 987.65, - "main_final_price": 123.45, - "main_price": 123.45 -} -``` - - - -### PriceRange - -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 Name | Description | -|------------|-------------| -| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | -| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | - -#### Example - -```json -{ - "maximum_price": ProductPrice, - "minimum_price": ProductPrice -} -``` - - - -### PriceTypeEnum - -Defines the price type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FIXED` | | -| `PERCENT` | | -| `DYNAMIC` | | - -#### Example - -```json -""FIXED"" -``` - - - -### PriceViewEnum - -Defines whether a bundle product's price is displayed as the lowest possible value or as a range. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRICE_RANGE` | | -| `AS_LOW_AS` | | - -#### Example - -```json -""PRICE_RANGE"" -``` - - - -### ProductAttribute - -Contains a product attribute code and value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | - -#### Example - -```json -{ - "code": "xyz789", - "value": "abc123" -} -``` - - - -### ProductAttributeFilterInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `activity` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Activity | -| `category_gear` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Category Gear | -| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `category_url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by category URL path. | -| `climate` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Climate | -| `collar` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Collar | -| `color` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Color | -| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | -| `eco_collection` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Eco Collection | -| `erin_recommends` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Erin Recommends | -| `features_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Features | -| `format` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Format | -| `gender` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Gender | -| `material` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Material | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | -| `new` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: New | -| `pattern` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Pattern | -| `performance_fabric` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Performance Fabric | -| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | -| `purpose` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Purpose | -| `sale` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sale | -| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | -| `size` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Size | -| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | -| `sleeve` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sleeve | -| `strap_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Strap/Handle | -| `style_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bags | -| `style_bottom` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bottom | -| `style_general` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style General | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | - -#### Example - -```json -{ - "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 -} -``` - - - -### ProductAttributeSortInput - -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 - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | - -#### Example - -```json -{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} -``` - - - -### ProductCustomAttributes - -Product custom attributes - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | - -#### Example - -```json -{ - "errors": [AttributeMetadataError], - "items": [AttributeValueInterface] -} -``` - - - -### ProductDiscount - -Contains the discount applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | - -#### Example - -```json -{"amount_off": 987.65, "percent_off": 987.65} -``` - - - -### ProductFilterInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | -| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | -| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "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 -} -``` - - - -### ProductImage - -Contains product image information, including the image URL and label. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Example - -```json -{ - "disabled": false, - "label": "abc123", - "position": 987, - "url": "abc123" -} -``` - - - -### ProductImageThumbnail - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ITSELF` | Use thumbnail of product as image. | -| `PARENT` | Use thumbnail of product's parent as image. | - -#### Example - -```json -""ITSELF"" -``` - - - -### ProductInfoInput - -Product Information used for Pickup Locations search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | - -#### Example - -```json -{"sku": "xyz789"} -``` - - - -### ProductInterface - -Contains fields that are common to all types of products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Possible Types - -| ProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | - -#### Example - -```json -{ - "activity": "xyz789", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "xyz789", - "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": "abc123", - "format": 123, - "gender": "abc123", - "gift_message_available": false, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, - "material": "abc123", - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "abc123", - "new": 987, - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options_container": "abc123", - "pattern": "abc123", - "performance_fabric": 987, - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "purpose": 987, - "quantity": 123.45, - "rating_summary": 123.45, - "related_products": [ProductInterface], - "review_count": 123, - "reviews": ProductReviews, - "rules": [CatalogRule], - "sale": 123, - "short_description": ComplexTextValue, - "size": 123, - "sku": "abc123", - "sleeve": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "xyz789", - "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_id": "abc123", - "uid": "4", - "updated_at": "abc123", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website] -} -``` - - - -### ProductLinks - -An implementation of `ProductLinksInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Example - -```json -{ - "link_type": "abc123", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 123, - "sku": "xyz789" -} -``` - - - -### ProductLinksInterface - -Contains information about linked products, including the link type and product type of each item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Possible Types - -| ProductLinksInterface Types | -|----------------| -| [`ProductLinks`](#productlinks) | - -#### Example - -```json -{ - "link_type": "abc123", - "linked_product_sku": "abc123", - "linked_product_type": "xyz789", - "position": 123, - "sku": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesContent - -Contains an image in base64 format and basic information about the image. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | -| `name` - [`String`](#string) | The file name of the image. | -| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | - -#### Example - -```json -{ - "base64_encoded_data": "xyz789", - "name": "abc123", - "type": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesVideoContent - -Contains a link to a video file and basic information about the video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `media_type` - [`String`](#string) | Must be external-video. | -| `video_description` - [`String`](#string) | A description of the video. | -| `video_metadata` - [`String`](#string) | Optional data about the video. | -| `video_provider` - [`String`](#string) | Describes the video source. | -| `video_title` - [`String`](#string) | The title of the video. | -| `video_url` - [`String`](#string) | The URL to the video. | - -#### Example - -```json -{ - "media_type": "abc123", - "video_description": "abc123", - "video_metadata": "xyz789", - "video_provider": "xyz789", - "video_title": "abc123", - "video_url": "xyz789" -} -``` - - - -### ProductPrice - -Represents a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | -| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | -| `regular_price` - [`Money!`](#money) | The regular price of the product. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "fixed_product_taxes": [FixedProductTax], - "regular_price": Money -} -``` - - - -### ProductPrices - -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 Name | Description | -|------------|-------------| -| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | -| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | -| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | - -#### Example - -```json -{ - "maximalPrice": Price, - "minimalPrice": Price, - "regularPrice": Price -} -``` - - - -### ProductReview - -Contains details of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](#string) | The date the review was created. | -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | -| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | - -#### Example - -```json -{ - "average_rating": 123.45, - "created_at": "xyz789", - "nickname": "xyz789", - "product": ProductInterface, - "ratings_breakdown": [ProductReviewRating], - "summary": "xyz789", - "text": "abc123" -} -``` - - - -### ProductReviewRating - -Contains data about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### ProductReviewRatingInput - -Contains the reviewer's rating for a single aspect of a review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "id": "abc123", - "value_id": "abc123" -} -``` - - - -### ProductReviewRatingMetadata - -Contains details about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | - -#### Example - -```json -{ - "id": "xyz789", - "name": "xyz789", - "values": [ProductReviewRatingValueMetadata] -} -``` - - - -### ProductReviewRatingValueMetadata - -Contains details about a single value in a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "value": "abc123", - "value_id": "xyz789" -} -``` - - - -### ProductReviewRatingsMetadata - -Contains an array of metadata about each aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | - -#### Example - -```json -{"items": [ProductReviewRatingMetadata]} -``` - - - -### ProductReviews - -Contains an array of product reviews. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | - -#### Example - -```json -{ - "items": [ProductReview], - "page_info": SearchResultPageInfo -} -``` - - - -### ProductStockStatus - -This enumeration states whether a product stock status is in stock or out of stock - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `IN_STOCK` | | -| `OUT_OF_STOCK` | | - -#### Example - -```json -""IN_STOCK"" -``` - - - -### ProductTierPrices - -Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | - -#### Example - -```json -{ - "customer_group_id": "xyz789", - "percentage_value": 123.45, - "qty": 987.65, - "value": 123.45, - "website_id": 987.65 -} -``` - - - -### ProductVideo - -Contains information about a product video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | - -#### Example - -```json -{ - "disabled": false, - "label": "abc123", - "position": 987, - "url": "xyz789", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### Products - -Contains the results of a `products` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | -| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](#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 - -```json -{ - "aggregations": [Aggregation], - "filters": [LayerFilter], - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "suggestions": [SearchSuggestion], - "total_count": 987 -} -``` - - - -### PurchaseOrder - -Contains details about a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | -| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | -| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | -| `created_at` - [`String!`](#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | -| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | -| `number` - [`String!`](#string) | The purchase order number. | -| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | -| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | - -#### Example - -```json -{ - "approval_flow": [PurchaseOrderRuleApprovalFlow], - "available_actions": ["REJECT"], - "comments": [PurchaseOrderComment], - "created_at": "abc123", - "created_by": Customer, - "history_log": [PurchaseOrderHistoryItem], - "number": "xyz789", - "order": CustomerOrder, - "quote": Cart, - "status": "PENDING", - "uid": "4", - "updated_at": "abc123" -} -``` - - - -### PurchaseOrderAction - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REJECT` | | -| `CANCEL` | | -| `VALIDATE` | | -| `APPROVE` | | -| `PLACE_ORDER` | | - -#### Example - -```json -""REJECT"" -``` - - - -### PurchaseOrderActionError - -Contains details about a failed action. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | - -#### Example - -```json -{"message": "abc123", "type": "NOT_FOUND"} -``` - - - -### PurchaseOrderApprovalFlowEvent - -Contains details about a single event in the approval flow of the purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | -| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](#string) | The date and time the event was updated. | - -#### Example - -```json -{ - "message": "xyz789", - "name": "xyz789", - "role": "abc123", - "status": "PENDING", - "updated_at": "xyz789" -} -``` - - - -### PurchaseOrderApprovalFlowItemStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVED` | | -| `REJECTED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrderApprovalRule - -Contains details about a purchase order approval rule. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | -| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | -| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](#string) | The name of the purchase order approval rule. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | - -#### Example - -```json -{ - "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" -} -``` - - - -### PurchaseOrderApprovalRuleConditionAmount - -Contains approval rule condition details, including the amount to be evaluated. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Example - -```json -{ - "amount": Money, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN" -} -``` - - - -### PurchaseOrderApprovalRuleConditionInterface - -Purchase order rule condition details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Possible Types - -| PurchaseOrderApprovalRuleConditionInterface Types | -|----------------| -| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | -| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} -``` - - - -### PurchaseOrderApprovalRuleConditionOperator - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `MORE_THAN` | | -| `LESS_THAN` | | -| `MORE_THAN_OR_EQUAL_TO` | | -| `LESS_THAN_OR_EQUAL_TO` | | +| `document_identifier` - [`String`](#string) | The identifier of the reference document. | +| `document_name` - [`String!`](#string) | The title of the reference document. | +| `link_id` - [`ID!`](#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | #### Example ```json -""MORE_THAN"" +{ + "document_identifier": "abc123", + "document_name": "xyz789", + "link_id": "4", + "reference_document_url": "xyz789" +} ``` -### PurchaseOrderApprovalRuleConditionQuantity - -Contains approval rule condition details, including the quantity to be evaluated. +### NegotiableQuoteShippingAddress #### Fields | Field Name | Description | |------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | -| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{ + "available_shipping_methods": [AvailableShippingMethod], + "city": "xyz789", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "xyz789", + "postcode": "xyz789", + "region": NegotiableQuoteAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "telephone": "xyz789" +} ``` -### PurchaseOrderApprovalRuleInput +### NegotiableQuoteShippingAddressInput -Defines a new purchase order approval rule. +Defines shipping addresses for the negotiable quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](#string) | The purchase order approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json { - "applies_to": ["4"], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "xyz789", - "status": "ENABLED" + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "customer_notes": "xyz789" } ``` -### PurchaseOrderApprovalRuleMetadata +### NegotiableQuoteSortInput -Contains metadata that can be used to render rule edit forms. +Defines the field to use to sort a list of negotiable quotes. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example ```json -{ - "available_applies_to": [CompanyRole], - "available_condition_currencies": [AvailableCurrency], - "available_requires_approval_from": [CompanyRole] -} +{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} ``` -### PurchaseOrderApprovalRuleStatus +### NegotiableQuoteSortableField #### Values | Enum Value | Description | |------------|-------------| -| `ENABLED` | | -| `DISABLED` | | +| `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 ```json -""ENABLED"" +""QUOTE_NAME"" ``` -### PurchaseOrderApprovalRuleType +### NegotiableQuoteStatus #### Values | Enum Value | Description | |------------|-------------| -| `GRAND_TOTAL` | | -| `SHIPPING_INCL_TAX` | | -| `NUMBER_OF_SKUS` | | +| `SUBMITTED` | | +| `PENDING` | | +| `UPDATED` | | +| `OPEN` | | +| `ORDERED` | | +| `CLOSED` | | +| `DECLINED` | | +| `EXPIRED` | | +| `DRAFT` | | #### Example ```json -""GRAND_TOTAL"" +""SUBMITTED"" ``` -### PurchaseOrderApprovalRules +### NegotiableQuoteTemplate -Contains the approval rules that the customer can see. +Contains details about a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `reference_document_links` - [`[NegotiableQuoteReferenceDocumentLink]`](#negotiablequotereferencedocumentlink) | A list of reference document links for the negotiable quote template. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | #### Example ```json { - "items": [PurchaseOrderApprovalRule], - "page_info": SearchResultPageInfo, - "total_count": 987 + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "expiration_date": "xyz789", + "history": [NegotiableQuoteHistoryEntry], + "is_min_max_qty_used": true, + "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": 123.45 } ``` -### PurchaseOrderComment +### NegotiableQuoteTemplateFilterInput -Contains details about a comment. +Defines a filter to limit the negotiable quotes to return. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `author` - [`Customer`](#customer) | The user who left the comment. | -| `created_at` - [`String!`](#string) | The date and time when the comment was created. | -| `text` - [`String!`](#string) | The text of the comment. | -| `uid` - [`ID!`](#id) | A unique identifier of the comment. | +| Input Field | Description | +|-------------|-------------| +| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example ```json { - "author": Customer, - "created_at": "xyz789", - "text": "xyz789", - "uid": 4 + "state": FilterEqualTypeInput, + "status": FilterEqualTypeInput } ``` -### PurchaseOrderErrorType +### NegotiableQuoteTemplateGridItem -#### Values +Contains data for a negotiable quote template in a grid. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | +| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `state` - [`String!`](#string) | State of the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -""NOT_FOUND"" +{ + "activated_at": "abc123", + "company_name": "abc123", + "expiration_date": "xyz789", + "is_min_max_qty_used": true, + "last_shared_at": "xyz789", + "max_order_commitment": 987, + "min_negotiated_grand_total": 987.65, + "min_order_commitment": 987, + "name": "abc123", + "orders_placed": 123, + "sales_rep_name": "xyz789", + "state": "xyz789", + "status": "abc123", + "submitted_by": "abc123", + "template_id": "4" +} ``` -### PurchaseOrderHistoryItem +### NegotiableQuoteTemplateItemQuantityInput -Contains details about a status change. +Specifies the updated quantity of an item. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `activity` - [`String!`](#string) | The activity type of the event. | -| `created_at` - [`String!`](#string) | The date and time when the event happened. | -| `message` - [`String!`](#string) | The message representation of the event. | -| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | #### Example -```json -{ - "activity": "abc123", - "created_at": "xyz789", - "message": "xyz789", - "uid": 4 -} +```json +{"item_id": 4, "max_qty": 123.45, "min_qty": 987.65, "quantity": 987.65} ``` -### PurchaseOrderRuleApprovalFlow +### NegotiableQuoteTemplateReferenceDocumentLinkInput -Contains details about approval roles applied to the purchase order and status changes. +Defines the reference document link to add to a negotiable quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| Input Field | Description | +|-------------|-------------| +| `document_identifier` - [`String`](#string) | The identifier of the reference document. | +| `document_name` - [`String!`](#string) | The title of the reference document. | +| `link_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | #### Example ```json { - "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "document_identifier": "abc123", + "document_name": "xyz789", + "link_id": 4, + "reference_document_url": "abc123" } ``` -### PurchaseOrderStatus +### NegotiableQuoteTemplateShippingAddressInput -#### Values +Defines shipping addresses for the negotiable quote template. -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVAL_REQUIRED` | | -| `APPROVED` | | -| `ORDER_IN_PROGRESS` | | -| `ORDER_PLACED` | | -| `ORDER_FAILED` | | -| `REJECTED` | | -| `CANCELED` | | -| `APPROVED_PENDING_PAYMENT` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json -""PENDING"" +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "customer_notes": "xyz789" +} ``` -### PurchaseOrders +### NegotiableQuoteTemplateSortInput -Contains a list of purchase orders. +Defines the field to use to sort a list of negotiable quotes. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example ```json -{ - "items": [PurchaseOrder], - "page_info": SearchResultPageInfo, - "total_count": 987 -} +{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} ``` -### PurchaseOrdersActionInput - -Defines which purchase orders to act on. +### NegotiableQuoteTemplateSortableField -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| Enum Value | Description | +|------------|-------------| +| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | +| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | #### Example ```json -{"purchase_order_uids": ["4"]} +""TEMPLATE_ID"" ``` -### PurchaseOrdersActionOutput +### NegotiableQuoteTemplatesOutput -Returns a list of updated purchase orders and any error messages. +Contains a list of negotiable templates that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | +| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | #### Example ```json { - "errors": [PurchaseOrderActionError], - "purchase_orders": [PurchaseOrder] + "items": [NegotiableQuoteTemplateGridItem], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 } ``` -### PurchaseOrdersFilterInput +### NegotiableQuoteUidNonFatalResultInterface -Defines the criteria to use to filter the list of purchase orders. +#### Fields -#### Input Fields +| Field Name | Description | +|------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| Input Field | Description | -|-------------|-------------| -| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | -| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | +#### Possible Types + +| NegotiableQuoteUidNonFatalResultInterface Types | +|----------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | #### Example ```json -{ - "company_purchase_orders": true, - "created_date": FilterRangeTypeInput, - "require_my_approval": false, - "status": "PENDING" -} +{"quote_uid": "4"} ``` -### QuoteItemsSortInput +### NegotiableQuoteUidOperationSuccess -Specifies the field to use for sorting quote items +Contains details about a successful operation on a negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | -| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | +| Field Name | Description | +|------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"field": "ITEM_ID", "order": "ASC"} +{"quote_uid": "4"} ``` -### QuoteTemplateLineItemNoteInput +### NegotiableQuoteUser -Sets quote item note. +A limited view of a Buyer or Seller in the negotiable quote process. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| Field Name | Description | +|------------|-------------| +| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | #### Example ```json { - "item_id": 4, - "note": "xyz789", - "templateId": "4" + "firstname": "xyz789", + "lastname": "xyz789" } ``` -### QuoteTemplateNotificationMessage +### NegotiableQuotesOutput -Contains a notification message for a negotiable quote template. +Contains a list of negotiable that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The notification message. | -| `type` - [`String!`](#string) | The type of notification message. | +| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | #### Example ```json { - "message": "abc123", - "type": "xyz789" + "items": [NegotiableQuote], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 } ``` -### ReCaptchaConfigOutput +### NoSuchEntityUidError + +Contains an error message when an invalid UID was specified. #### Fields | Field Name | Description | |------------|-------------| -| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | +| `message` - [`String!`](#string) | The returned error message. | +| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | #### Example ```json { - "configurations": ReCaptchaConfiguration, - "is_enabled": true + "message": "abc123", + "uid": "4" } ``` -### ReCaptchaConfiguration +### OpenNegotiableQuoteTemplateInput -Contains reCAPTCHA form configuration details. +Specifies the quote template id to open quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `badge_position` - [`String`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `re_captcha_type` - [`ReCaptchaTypeEmum!`](#recaptchatypeemum) | | -| `technical_failure_message` - [`String!`](#string) | The message that appears when reCaptcha fails. | -| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | -| `validation_failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{ - "badge_position": "abc123", - "language_code": "abc123", - "minimum_score": 987.65, - "re_captcha_type": "INVISIBLE", - "technical_failure_message": "abc123", - "theme": "abc123", - "validation_failure_message": "xyz789", - "website_key": "abc123" -} +{"template_id": "4"} ``` -### ReCaptchaConfigurationV3 +### Order -Contains reCAPTCHA V3-Invisible configuration details. +Contains the order ID. #### Fields | Field Name | Description | |------------|-------------| -| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | -| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | +| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | #### Example ```json { - "badge_position": "xyz789", - "failure_message": "xyz789", - "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "xyz789", - "minimum_score": 123.45, - "theme": "xyz789", - "website_key": "xyz789" + "order_id": "xyz789", + "order_number": "xyz789" } ``` -### ReCaptchaFormEnum +### OrderActionType + +The list of available order actions. #### Values | Enum Value | Description | |------------|-------------| -| `PLACE_ORDER` | | -| `CONTACT` | | -| `CUSTOMER_LOGIN` | | -| `CUSTOMER_FORGOT_PASSWORD` | | -| `CUSTOMER_CREATE` | | -| `CUSTOMER_EDIT` | | -| `NEWSLETTER` | | -| `PRODUCT_REVIEW` | | -| `SENDFRIEND` | | -| `BRAINTREE` | | -| `RESEND_CONFIRMATION_EMAIL` | | +| `REORDER` | | +| `CANCEL` | | +| `RETURN` | | #### Example ```json -""PLACE_ORDER"" +""REORDER"" ``` -### ReCaptchaTypeEmum +### OrderAddress -#### Values +Contains detailed information about an order's billing and shipping addresses. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `INVISIBLE` | | -| `RECAPTCHA` | | -| `RECAPTCHA_V3` | | +| `city` - [`String!`](#string) | The city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](#string) | The fax number. | +| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | The state or province name. | +| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json -""INVISIBLE"" +{ + "city": "abc123", + "company": "abc123", + "country_code": "AF", + "custom_attributesV2": [AttributeValueInterface], + "fax": "abc123", + "firstname": "abc123", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": "xyz789", + "region_id": 4, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" +} ``` -### Region +### OrderCustomerInfo #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](#int) | The unique ID for a `Region` object. | -| `name` - [`String`](#string) | The name of the region, such as Texas. | +| `firstname` - [`String!`](#string) | First name of the customer | +| `lastname` - [`String`](#string) | Last name of the customer | +| `middlename` - [`String`](#string) | Middle name of the customer | +| `prefix` - [`String`](#string) | Prefix of the customer | +| `suffix` - [`String`](#string) | Suffix of the customer | #### Example ```json { - "code": "abc123", - "id": 123, - "name": "xyz789" + "firstname": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "prefix": "abc123", + "suffix": "abc123" } ``` -### RemoveCouponFromCartInput +### OrderInformationInput -Specifies the cart from which to remove a coupon. +Input to retrieve an order based on details. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `email` - [`String!`](#string) | Order billing address email. | +| `lastname` - [`String!`](#string) | Order billing address lastname. | +| `number` - [`String!`](#string) | Order number. | #### Example ```json -{"cart_id": "abc123"} +{ + "email": "xyz789", + "lastname": "xyz789", + "number": "abc123" +} ``` -### RemoveCouponFromCartOutput - -Contains details about the cart after removing a coupon. +### OrderItem #### Fields | Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveCouponsFromCartInput - -Remove coupons from the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#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. | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "cart_id": "xyz789", - "coupon_codes": ["abc123"] + "discounts": [Discount], + "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": "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": 123.45, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "xyz789" } ``` -### RemoveGiftCardFromCartInput +### OrderItemInterface -Defines the input required to run the `removeGiftCardFromCart` mutation. +Order item details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Possible Types + +| OrderItemInterface Types | +|----------------| +| [`ConfigurableOrderItem`](#configurableorderitem) | +| [`BundleOrderItem`](#bundleorderitem) | +| [`DownloadableOrderItem`](#downloadableorderitem) | +| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`OrderItem`](#orderitem) | #### Example ```json { - "cart_id": "abc123", - "gift_card_code": "xyz789" + "discounts": [Discount], + "eligible_for_return": false, + "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": "xyz789", + "quantity_canceled": 987.65, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, + "quantity_return_requested": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "abc123" } ``` -### RemoveGiftCardFromCartOutput +### OrderItemOption -Defines the possible output for the `removeGiftCardFromCart` mutation. +Represents order item options like selected or entered. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `label` - [`String!`](#string) | The name of the option. | +| `value` - [`String!`](#string) | The value of the option. | #### Example ```json -{"cart": Cart} +{ + "label": "abc123", + "value": "abc123" +} ``` -### RemoveGiftRegistryItemsOutput - -Contains the results of a request to remove an item from a gift registry. +### OrderItemPrices #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | +| `original_price` - [`Money`](#money) | The original price of the item. | +| `original_price_including_tax` - [`Money`](#money) | The original price of the item including tax. | +| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | +| `original_row_total_including_tax` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item including tax. | +| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money!`](#money) | The total of all discounts applied to the item. | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "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 +} ``` -### RemoveGiftRegistryOutput +### OrderPaymentMethod -Contains the results of a request to delete a gift registry. +Contains details about the payment method used to pay for the order. #### Fields | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | +| `name` - [`String!`](#string) | The label that describes the payment method. | +| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | #### Example ```json -{"success": true} +{ + "additional_data": [KeyValue], + "name": "abc123", + "type": "xyz789" +} ``` -### RemoveGiftRegistryRegistrantsOutput +### OrderShipment -Contains the results of a request to delete a registrant. +Contains order shipment details. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "comments": [SalesCommentItem], + "id": "4", + "items": [ShipmentItemInterface], + "number": "abc123", + "tracking": [ShipmentTracking] +} ``` -### RemoveItemFromCartInput +### OrderTokenInput -Specifies which items to remove from the cart. +Input to retrieve an order based on token. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `token` - [`String!`](#string) | Order token. | #### Example ```json -{ - "cart_id": "abc123", - "cart_item_id": 987, - "cart_item_uid": 4 -} +{"token": "abc123"} ``` -### RemoveItemFromCartOutput +### OrderTotal -Contains details about the cart after removing an item. +Contains details about the sales total amounts used to calculate the final price. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | +| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. *(Deprecated: Use subtotal_excl_tax field instead)* | +| `subtotal_excl_tax` - [`Money!`](#money) | The subtotal of the order, excluding taxes. | +| `subtotal_incl_tax` - [`Money!`](#money) | The subtotal of the order, including taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | +| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | +| `total_reward_points` - [`Money`](#money) | The total reward points applied to the order. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | +| `total_store_credit` - [`Money`](#money) | The total store credit applied to the order. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | #### Example ```json -{"cart": Cart} +{ + "base_grand_total": Money, + "discounts": [Discount], + "gift_options": GiftOptionsPrices, + "grand_total": 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 +} ``` -### RemoveNegotiableQuoteItemsInput +### PayflowExpressInput -Defines the items to remove from the specified negotiable quote. +Contains required input for Payflow Express Checkout payments. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json -{"quote_item_uids": [4], "quote_uid": 4} +{ + "payer_id": "abc123", + "token": "abc123" +} ``` -### RemoveNegotiableQuoteItemsOutput +### PayflowLinkInput -Contains the negotiable quote. +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 Fields -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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!`](#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 ```json -{"quote": NegotiableQuote} +{ + "cancel_url": "xyz789", + "error_url": "xyz789", + "return_url": "abc123" +} ``` -### RemoveNegotiableQuoteTemplateItemsInput +### PayflowLinkMode -Defines the items to remove from the specified negotiable quote. +Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| Enum Value | Description | +|------------|-------------| +| `TEST` | | +| `LIVE` | | #### Example ```json -{"item_uids": [4], "template_id": 4} +""TEST"" ``` -### RemoveProductsFromCompareListInput +### PayflowLinkToken -Defines which products to remove from a compare list. +Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| Field Name | Description | +|------------|-------------| +| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | +| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | #### Example ```json { - "products": ["4"], - "uid": "4" + "mode": "TEST", + "paypal_url": "abc123", + "secure_token": "abc123", + "secure_token_id": "abc123" } ``` -### RemoveProductsFromWishlistOutput - -Contains the customer's wish list and any errors encountered. +### PayflowLinkTokenInput -#### Fields +Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} +{"cart_id": "xyz789"} ``` -### RemoveReturnTrackingInput +### PayflowProInput -Defines the tracking information to delete. +Contains input for the Payflow Pro and Payments Pro payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](#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 ```json -{"return_shipping_tracking_uid": "4"} +{ + "cc_details": CreditCardDetailsInput, + "is_active_payment_token_enabler": false +} ``` -### RemoveReturnTrackingOutput +### PayflowProResponseInput -Contains the response after deleting tracking information. +Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `return` - [`Return`](#return) | Contains details about the modified return. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | #### Example ```json -{"return": Return} +{ + "cart_id": "abc123", + "paypal_payload": "xyz789" +} ``` -### RemoveRewardPointsFromCartOutput - -Contains the customer cart. +### PayflowProResponseOutput #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | #### Example @@ -4843,2230 +2137,2524 @@ Contains the customer cart. -### RemoveStoreCreditFromCartInput +### PayflowProTokenInput -Defines the input required to run the `removeStoreCreditFromCart` mutation. +Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### RemoveStoreCreditFromCartOutput - -Defines the possible output for the `removeStoreCreditFromCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example ```json -{"cart": Cart} +{ + "cart_id": "abc123", + "urls": PayflowProUrlInput +} ``` -### RenameNegotiableQuoteInput +### PayflowProUrlInput -Sets new name for a negotiable quote. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | -| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | -| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `cancel_url` - [`String!`](#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!`](#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!`](#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 ```json { - "quote_comment": "abc123", - "quote_name": "abc123", - "quote_uid": "4" + "cancel_url": "xyz789", + "error_url": "abc123", + "return_url": "xyz789" } ``` -### RenameNegotiableQuoteOutput +### PaymentConfigItem -Contains the updated negotiable quote. +Contains payment fields that are common to all types of payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Possible Types + +| PaymentConfigItem Types | +|----------------| +| [`HostedFieldsConfig`](#hostedfieldsconfig) | +| [`SmartButtonsConfig`](#smartbuttonsconfig) | +| [`ApplePayConfig`](#applepayconfig) | +| [`GooglePayConfig`](#googlepayconfig) | #### Example ```json -{"quote": NegotiableQuote} +{ + "code": "abc123", + "is_visible": false, + "payment_intent": "xyz789", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "abc123" +} ``` -### ReorderItemsOutput +### PaymentConfigOutput -Contains the cart and any errors after adding products. +Retrieves the payment configuration for a given location #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | +| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example ```json { - "cart": Cart, - "userInputErrors": [CheckoutUserInputError] + "apple_pay": ApplePayConfig, + "google_pay": GooglePayConfig, + "hosted_fields": HostedFieldsConfig, + "smart_buttons": SmartButtonsConfig } ``` -### RequestGuestReturnInput +### PaymentLocation -Contains information needed to start a return request. +Defines the origin location for that payment request -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `token` - [`String!`](#string) | Order token. | +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_DETAIL` | | +| `MINICART` | | +| `CART` | | +| `CHECKOUT` | | +| `ADMIN` | | #### Example ```json -{ - "comment_text": "xyz789", - "contact_email": "abc123", - "items": [RequestReturnItemInput], - "token": "abc123" -} +""PRODUCT_DETAIL"" ``` -### RequestNegotiableQuoteInput +### PaymentMethodInput -Defines properties of a negotiable quote request. +Defines the payment method. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | -| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | +| `braintree` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `code` - [`String!`](#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | +| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | +| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | +| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | +| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "cart_id": "4", - "comment": NegotiableQuoteCommentInput, - "is_draft": false, - "quote_name": "abc123" + "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_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": "abc123" } ``` -### RequestNegotiableQuoteOutput +### PaymentOrderOutput -Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. +Contains the payment order details #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json -{"quote": NegotiableQuote} +{ + "id": "xyz789", + "mp_order_id": "xyz789", + "payment_source_details": PaymentSourceDetails, + "status": "abc123" +} ``` -### RequestNegotiableQuoteTemplateInput - -Defines properties of a negotiable quote template request. +### PaymentSDKParamsItem -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | #### Example ```json -{"cart_id": "4"} +{ + "code": "xyz789", + "params": [SDKParams] +} ``` -### RequestReturnInput - -Contains information needed to start a return request. +### PaymentSourceDetails -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | +| Field Name | Description | +|------------|-------------| +| `card` - [`Card`](#card) | Details about the card used on the order | #### Example ```json -{ - "comment_text": "xyz789", - "contact_email": "abc123", - "items": [RequestReturnItemInput], - "order_uid": 4 -} +{"card": Card} ``` -### RequestReturnItemInput +### PaymentSourceInput -Contains details about an item to be returned. +The payment source information #### Input Fields | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | -| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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. | +| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | #### Example ```json -{ - "entered_custom_attributes": [ - EnteredCustomAttributeInput - ], - "order_item_uid": 4, - "quantity_to_return": 123.45, - "selected_custom_attributes": [ - SelectedCustomAttributeInput - ] -} +{"card": CardPaymentSourceInput} ``` -### RequestReturnOutput +### PaymentSourceOutput -Contains the response to a return request. +The payment source information #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about a single return request. | -| `returns` - [`Returns`](#returns) | An array of return requests. | +| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | #### Example ```json -{ - "return": Return, - "returns": Returns -} +{"card": CardPaymentSourceOutput} ``` -### RequisitionList +### PaymentToken -Defines the contents of a requisition list. +The stored payment method available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String`](#string) | Optional text that describes the requisition list. | -| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | -| `items_count` - [`Int!`](#int) | The number of items in the list. | -| `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | -| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | +| `details` - [`String`](#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](#string) | The public hash of the token. | +| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "description": "xyz789", - "items": RequistionListItems, - "items_count": 123, - "name": "xyz789", - "uid": "4", - "updated_at": "abc123" + "details": "abc123", + "payment_method_code": "xyz789", + "public_hash": "abc123", + "type": "card" } ``` -### RequisitionListFilterInput +### PaymentTokenTypeEnum -Defines requisition list filters. +The list of available payment token types. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| Enum Value | Description | +|------------|-------------| +| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | #### Example ```json -{ - "name": FilterMatchTypeInput, - "uids": FilterEqualTypeInput -} +""card"" ``` -### RequisitionListItemInterface - -The interface for requisition list items. - -#### Fields +### PaypalExpressInput -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +Contains required input for Express Checkout and Payments Standard payments. -#### Possible Types +#### Input Fields -| RequisitionListItemInterface Types | -|----------------| -| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | +| Input Field | Description | +|-------------|-------------| +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "payer_id": "xyz789", + "token": "xyz789" } ``` -### RequisitionListItemsInput +### PaypalExpressTokenInput -Defines the items to add. +Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | -| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](#float) | The quantity of the product to add. | -| `selected_options` - [`[String]`](#string) | Selected option IDs. | -| `sku` - [`String!`](#string) | The product SKU. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](#string) | The payment method code. | +| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | +| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 987.65, - "selected_options": ["abc123"], - "sku": "xyz789" + "cart_id": "xyz789", + "code": "abc123", + "express_button": false, + "urls": PaypalExpressUrlsInput, + "use_paypal_credit": true } ``` -### RequisitionLists +### PaypalExpressTokenOutput -Defines customer requisition lists. +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 Name | Description | |------------|-------------| -| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | +| `token` - [`String`](#string) | The token returned by PayPal. | #### Example ```json { - "items": [RequisitionList], - "page_info": SearchResultPageInfo, - "total_count": 123 + "paypal_urls": PaypalExpressUrlList, + "token": "xyz789" } ``` -### RequistionListItems +### PaypalExpressUrlList -Contains an array of items added to a requisition list. +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 Name | Description | |------------|-------------| -| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](#int) | The number of pages returned. | +| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](#string) | The URL to the PayPal login page. | #### Example ```json { - "items": [RequisitionListItemInterface], - "page_info": SearchResultPageInfo, - "total_pages": 123 + "edit": "abc123", + "start": "abc123" } ``` -### Return +### PaypalExpressUrlsInput -Contains details about a return. +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 Fields -| Field Name | Description | -|------------|-------------| -| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | -| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | -| `created_at` - [`String!`](#string) | The date the return was requested. | -| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | -| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | -| `number` - [`String!`](#string) | A human-readable return number. | -| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | -| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | -| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | -| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 ```json { - "available_shipping_carriers": [ReturnShippingCarrier], - "comments": [ReturnComment], - "created_at": "xyz789", - "customer": ReturnCustomer, - "items": [ReturnItem], - "number": "abc123", - "order": CustomerOrder, - "shipping": ReturnShipping, - "status": "PENDING", - "uid": "4" + "cancel_url": "xyz789", + "pending_url": "xyz789", + "return_url": "abc123", + "success_url": "abc123" } ``` -### ReturnComment +### PhysicalProductInterface -Contains details about a return comment. +Contains attributes specific to tangible products. #### Fields | Field Name | Description | |------------|-------------| -| `author_name` - [`String!`](#string) | The name or author who posted the comment. | -| `created_at` - [`String!`](#string) | The date and time the comment was posted. | -| `text` - [`String!`](#string) | The contents of the comment. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Possible Types + +| PhysicalProductInterface Types | +|----------------| +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | #### Example ```json -{ - "author_name": "xyz789", - "created_at": "abc123", - "text": "xyz789", - "uid": "4" -} +{"weight": 123.45} ``` -### ReturnCustomAttribute +### PickupLocation -Contains details about a `ReturnCustomerAttribute` object. +Defines Pickup Location information. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | -| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | +| `city` - [`String`](#string) | | +| `contact_name` - [`String`](#string) | | +| `country_id` - [`String`](#string) | | +| `description` - [`String`](#string) | | +| `email` - [`String`](#string) | | +| `fax` - [`String`](#string) | | +| `latitude` - [`Float`](#float) | | +| `longitude` - [`Float`](#float) | | +| `name` - [`String`](#string) | | +| `phone` - [`String`](#string) | | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | | +| `region` - [`String`](#string) | | +| `region_id` - [`Int`](#int) | | +| `street` - [`String`](#string) | | #### Example ```json { - "label": "xyz789", - "uid": 4, - "value": "abc123" + "city": "xyz789", + "contact_name": "abc123", + "country_id": "xyz789", + "description": "abc123", + "email": "abc123", + "fax": "xyz789", + "latitude": 123.45, + "longitude": 987.65, + "name": "xyz789", + "phone": "xyz789", + "pickup_location_code": "abc123", + "postcode": "xyz789", + "region": "abc123", + "region_id": 123, + "street": "xyz789" } ``` -### ReturnCustomer +### PickupLocationFilterInput -The customer information for the return. +PickupLocationFilterInput defines the list of attributes and filters for the search. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `email` - [`String!`](#string) | The email address of the customer. | -| `firstname` - [`String`](#string) | The first name of the customer. | -| `lastname` - [`String`](#string) | The last name of the customer. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | #### Example ```json { - "email": "abc123", - "firstname": "xyz789", - "lastname": "xyz789" + "city": FilterTypeInput, + "country_id": FilterTypeInput, + "name": FilterTypeInput, + "pickup_location_code": FilterTypeInput, + "postcode": FilterTypeInput, + "region": FilterTypeInput, + "region_id": FilterTypeInput, + "street": FilterTypeInput } ``` -### ReturnItem +### PickupLocationSortInput -Contains details about a product being returned. +PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | -| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | +| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | #### Example ```json { - "custom_attributes": [ReturnCustomAttribute], - "custom_attributesV2": [AttributeValueInterface], - "order_item": OrderItemInterface, - "quantity": 123.45, - "request_quantity": 123.45, - "status": "PENDING", - "uid": 4 + "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" } ``` -### ReturnItemAttributeMetadata +### PickupLocations -Return Item attribute metadata. +Top level object returned in a pickup locations search. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | +| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](#int) | The number of products returned. | #### Example ```json { - "code": "4", - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": true, - "is_unique": true, - "label": "xyz789", - "multiline_count": 987, - "options": [CustomAttributeOptionInterface], - "sort_order": 123, - "validate_rules": [ValidationRule] + "items": [PickupLocation], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### ReturnItemStatus +### PlaceNegotiableQuoteOrderInput -#### Values +Specifies the negotiable quote to convert to an order. -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `RECEIVED` | | -| `APPROVED` | | -| `REJECTED` | | -| `DENIED` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -""PENDING"" +{"quote_uid": 4} ``` -### ReturnShipping +### PlaceNegotiableQuoteOrderOutput -Contains details about the return shipping address. +An output object that returns the generated order. #### Fields | Field Name | Description | |------------|-------------| -| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | -| `tracking` - [`[ReturnShippingTracking]`](#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. | +| `order` - [`Order!`](#order) | Contains the generated order number. | #### Example ```json -{ - "address": ReturnShippingAddress, - "tracking": [ReturnShippingTracking] -} +{"order": Order} ``` -### ReturnShippingAddress +### PlaceOrderError -Contains details about the shipping address used for receiving returned items. +An error encountered while placing an order. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city for product returns. | -| `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](#country) | An object that defines the country for product returns. | -| `postcode` - [`String!`](#string) | The postal code for product returns. | -| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | -| `street` - [`[String]!`](#string) | The street address for product returns. | -| `telephone` - [`String`](#string) | The telephone number for product returns. | +| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "city": "abc123", - "contact_name": "xyz789", - "country": Country, - "postcode": "xyz789", - "region": Region, - "street": ["xyz789"], - "telephone": "xyz789" + "code": "CART_NOT_FOUND", + "message": "abc123" } ``` -### ReturnShippingCarrier - -Contains details about the carrier on a return. +### PlaceOrderErrorCodes -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| `CART_NOT_FOUND` | | +| `CART_NOT_ACTIVE` | | +| `GUEST_EMAIL_MISSING` | | +| `UNABLE_TO_PLACE_ORDER` | | +| `UNDEFINED` | | #### Example ```json -{"label": "abc123", "uid": 4} +""CART_NOT_FOUND"" ``` -### ReturnShippingTracking +### PlaceOrderForPurchaseOrderInput -Contains shipping and tracking details. +Specifies the purchase order to convert to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | -| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | -| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | #### Example ```json -{ - "carrier": ReturnShippingCarrier, - "status": ReturnShippingTrackingStatus, - "tracking_number": "abc123", - "uid": "4" -} +{"purchase_order_uid": 4} ``` -### ReturnShippingTrackingStatus +### PlaceOrderForPurchaseOrderOutput -Contains the status of a shipment. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `text` - [`String!`](#string) | Text that describes the status. | -| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | +| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | #### Example ```json -{"text": "xyz789", "type": "INFORMATION"} +{"order": CustomerOrder} ``` -### ReturnShippingTrackingStatusType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INFORMATION` | | -| `ERROR` | | - -#### Example - -```json -""INFORMATION"" -``` - - +### PlaceOrderInput -### ReturnStatus +Specifies the quote to be converted to an order. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `UNCONFIRMED` | | -| `AUTHORIZED` | | -| `PARTIALLY_AUTHORIZED` | | -| `RECEIVED` | | -| `PARTIALLY_RECEIVED` | | -| `APPROVED` | | -| `PARTIALLY_APPROVED` | | -| `REJECTED` | | -| `PARTIALLY_REJECTED` | | -| `DENIED` | | -| `PROCESSED_AND_CLOSED` | | -| `CLOSED` | | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -""PENDING"" +{"cart_id": "xyz789"} ``` -### Returns +### PlaceOrderOutput -Contains a list of customer return requests. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Return]`](#return) | A list of return requests. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | +| `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | +| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | #### Example ```json { - "items": [Return], - "page_info": SearchResultPageInfo, - "total_count": 123 + "errors": [PlaceOrderError], + "order": Order, + "orderV2": CustomerOrder } ``` -### RevokeCustomerTokenOutput +### PlacePurchaseOrderInput -Contains the result of a request to revoke a customer token. +Specifies the quote to be converted to a purchase order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -{"result": true} +{"cart_id": "abc123"} ``` -### RewardPoints +### PlacePurchaseOrderOutput -Contains details about a customer's reward points. +Contains the results of the request to place a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | -| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | -| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | +| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | #### Example ```json -{ - "balance": RewardPointsAmount, - "balance_history": [RewardPointsBalanceHistoryItem], - "exchange_rates": RewardPointsExchangeRates, - "subscription_status": RewardPointsSubscriptionStatus -} +{"purchase_order": PurchaseOrder} ``` -### RewardPointsAmount +### Price + +Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. #### Fields | Field Name | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | +| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | #### Example ```json -{"money": Money, "points": 987.65} +{ + "adjustments": [PriceAdjustment], + "amount": Money +} ``` -### RewardPointsBalanceHistoryItem +### PriceAdjustment -Contain details about the reward points transaction. +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 Name | Description | |------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | -| `change_reason` - [`String!`](#string) | The reason the balance changed. | -| `date` - [`String!`](#string) | The date of the transaction. | -| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | +| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | +| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | +| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | #### Example ```json { - "balance": RewardPointsAmount, - "change_reason": "abc123", - "date": "xyz789", - "points_change": 123.45 + "amount": Money, + "code": "TAX", + "description": "INCLUDED" } ``` -### RewardPointsExchangeRates +### PriceAdjustmentCodesEnum -Lists the reward points exchange rates. The values depend on the customer group. +`PriceAdjustment.code` is deprecated. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | -| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | +| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | +| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | +| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | #### Example ```json -{ - "earning": RewardPointsRate, - "redemption": RewardPointsRate -} +""TAX"" ``` -### RewardPointsRate +### PriceAdjustmentDescriptionEnum -Contains details about customer's reward points rate. +`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `currency_amount` - [`Float!`](#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!`](#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. | +| `INCLUDED` | | +| `EXCLUDED` | | #### Example ```json -{"currency_amount": 987.65, "points": 987.65} +""INCLUDED"" ``` -### RewardPointsSubscriptionStatus +### PriceDetails -Indicates whether the customer subscribes to reward points emails. +Can be used to retrieve the main price details in case of bundle product #### Fields | Field Name | Description | |------------|-------------| -| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | -| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | +| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](#float) | The regular price of the main product | #### Example ```json { - "balance_updates": "SUBSCRIBED", - "points_expiration_notifications": "SUBSCRIBED" + "discount_percentage": 123.45, + "main_final_price": 987.65, + "main_price": 123.45 } ``` -### RewardPointsSubscriptionStatusesEnum +### PriceRange -#### Values +Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `SUBSCRIBED` | | -| `NOT_SUBSCRIBED` | | +| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | +| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | #### Example ```json -""SUBSCRIBED"" +{ + "maximum_price": ProductPrice, + "minimum_price": ProductPrice +} ``` -### RoutableInterface +### PriceTypeEnum -Routable entities serve as the model for a rendered page. +Defines the price type. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Possible Types - -| RoutableInterface Types | -|----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`RoutableUrl`](#routableurl) | +| `FIXED` | | +| `PERCENT` | | +| `DYNAMIC` | | #### Example ```json -{ - "redirect_code": 987, - "relative_url": "abc123", - "type": "CMS_PAGE" -} +""FIXED"" ``` -### RoutableUrl +### PriceViewEnum -Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity. +Defines whether a bundle product's price is displayed as the lowest possible value or as a range. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `PRICE_RANGE` | | +| `AS_LOW_AS` | | #### Example ```json -{ - "redirect_code": 123, - "relative_url": "xyz789", - "type": "CMS_PAGE" -} +""PRICE_RANGE"" ``` -### SDKParams +### ProductAttribute -Defines the name and value of a SDK parameter +Contains a product attribute code and value. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String`](#string) | The name of the SDK parameter | -| `value` - [`String`](#string) | The value of the SDK parameter | +| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](#string) | The display value of the attribute. | #### Example ```json { - "name": "abc123", - "value": "xyz789" + "code": "abc123", + "value": "abc123" } ``` -### SalesCommentItem +### ProductAttributeFilterInput -Contains details about a comment. +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 Fields -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The text of the message. | -| `timestamp` - [`String!`](#string) | The timestamp of the comment. | +| Input Field | Description | +|-------------|-------------| +| `activity` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Activity | +| `category_gear` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Category Gear | +| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by category URL path. | +| `climate` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Climate | +| `collar` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Collar | +| `color` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Color | +| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | +| `eco_collection` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Eco Collection | +| `erin_recommends` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Erin Recommends | +| `features_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Features | +| `format` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Format | +| `gender` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Gender | +| `material` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Material | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | +| `new` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: New | +| `pattern` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Pattern | +| `performance_fabric` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Performance Fabric | +| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | +| `purpose` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Purpose | +| `sale` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sale | +| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | +| `size` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Size | +| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | +| `sleeve` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Sleeve | +| `strap_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Strap/Handle | +| `style_bags` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bags | +| `style_bottom` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style Bottom | +| `style_general` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: Style General | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | #### Example ```json { - "message": "abc123", - "timestamp": "abc123" + "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 } ``` -### ScopeTypeEnum +### ProductAttributeSortInput -This enumeration defines the scope type for customer orders. +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 -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `GLOBAL` | | -| `WEBSITE` | | -| `STORE` | | +| Input Field | Description | +|-------------|-------------| +| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | #### Example ```json -""GLOBAL"" +{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} ``` -### SearchResultPageInfo +### ProductCustomAttributes -Provides navigation for the query response. +Product custom attributes #### Fields | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](#int) | The specific page to return. | -| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](#int) | The total number of pages in the response. | +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | #### Example ```json -{"current_page": 987, "page_size": 987, "total_pages": 987} +{ + "errors": [AttributeMetadataError], + "items": [AttributeValueInterface] +} ``` -### SearchSuggestion +### ProductDiscount -A string that contains search suggestion +Contains the discount applied to a product price. #### Fields | Field Name | Description | |------------|-------------| -| `search` - [`String!`](#string) | The search suggestion of existing product. | +| `amount_off` - [`Float`](#float) | The actual value of the discount. | +| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | #### Example ```json -{"search": "xyz789"} +{"amount_off": 987.65, "percent_off": 987.65} ``` -### SelectedBundleOption +### ProductFilterInput -Contains details about a selected bundle option. +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 Fields -| Field Name | Description | -|------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | -| `label` - [`String!`](#string) | The display name of the selected bundle product option. | -| `type` - [`String!`](#string) | The type of selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | -| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | +| Input Field | Description | +|-------------|-------------| +| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | +| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example ```json -{ - "id": 123, - "label": "xyz789", - "type": "abc123", - "uid": "4", - "values": [SelectedBundleOptionValue] +{ + "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 } ``` -### SelectedBundleOptionValue +### ProductImage -Contains details about a value for a selected bundle option. +Contains product image information, including the image URL and label. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | -| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `original_price` - [`Money!`](#money) | The original price of the value for the selected bundle product option. | -| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | -| `priceV2` - [`Money!`](#money) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | #### Example ```json { - "id": 987, + "disabled": false, "label": "xyz789", - "original_price": Money, - "price": 987.65, - "priceV2": Money, - "quantity": 123.45, - "uid": "4" + "position": 987, + "url": "xyz789" } ``` -### SelectedConfigurableOption - -Contains details about a selected configurable option. +### ProductImageThumbnail -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | -| `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | -| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | +| `ITSELF` | Use thumbnail of product as image. | +| `PARENT` | Use thumbnail of product's parent as image. | #### Example ```json -{ - "configurable_product_option_uid": 4, - "configurable_product_option_value_uid": 4, - "id": 987, - "option_label": "abc123", - "value_id": 123, - "value_label": "abc123" -} +""ITSELF"" ``` -### SelectedCustomAttributeInput +### ProductInfoInput -Contains details about an attribute the buyer selected. +Product Information used for Pickup Locations search. #### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`String!`](#string) | The unique ID for a selected custom attribute value. | +| `sku` - [`String!`](#string) | Product SKU. | #### Example ```json -{ - "attribute_code": "xyz789", - "value": "abc123" -} +{"sku": "abc123"} ``` -### SelectedCustomizableOption +### ProductInterface -Identifies a customized product that has been placed in a cart. +Contains fields that are common to all types of products. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | -| `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | -| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | -| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Possible Types + +| ProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | #### Example ```json { - "customizable_option_uid": "4", + "activity": "abc123", + "attribute_set_id": 123, + "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": 987, + "erin_recommends": 987, + "features_bags": "xyz789", + "format": 987, + "gender": "xyz789", + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, "id": 987, - "is_required": false, - "label": "xyz789", - "sort_order": 123, - "type": "xyz789", - "values": [SelectedCustomizableOptionValue] + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "material": "abc123", + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options_container": "xyz789", + "pattern": "abc123", + "performance_fabric": 123, + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "purpose": 987, + "quantity": 987.65, + "rating_summary": 987.65, + "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 123, + "short_description": ComplexTextValue, + "size": 987, + "sku": "abc123", + "sleeve": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "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_id": "xyz789", + "uid": "4", + "updated_at": "abc123", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website] } ``` -### SelectedCustomizableOptionValue +### ProductLinks -Identifies the value of the selected customized option. +An implementation of `ProductLinksInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | -| `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | -| `value` - [`String!`](#string) | The text identifying the selected value. | +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | #### Example ```json { - "customizable_option_value_uid": 4, - "id": 123, - "label": "abc123", - "price": CartItemSelectedOptionValuePrice, - "value": "abc123" + "link_type": "xyz789", + "linked_product_sku": "abc123", + "linked_product_type": "xyz789", + "position": 987, + "sku": "xyz789" } ``` -### SelectedPaymentMethod +### ProductLinksInterface -Describes the payment method the shopper selected. +Contains information about linked products, including the link type and product type of each item. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. | -| `title` - [`String!`](#string) | The payment method title. | +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | + +#### Possible Types + +| ProductLinksInterface Types | +|----------------| +| [`ProductLinks`](#productlinks) | #### Example ```json { - "code": "xyz789", - "purchase_order_number": "abc123", - "title": "xyz789" + "link_type": "xyz789", + "linked_product_sku": "xyz789", + "linked_product_type": "abc123", + "position": 123, + "sku": "abc123" } ``` -### SelectedShippingMethod +### ProductMediaGalleryEntriesContent -Contains details about the selected shipping method and carrier. +Contains an image in base64 format and basic information about the image. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | -| `method_title` - [`String!`](#string) | The label for the method code. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | +| `name` - [`String`](#string) | The file name of the image. | +| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | #### Example ```json { - "amount": Money, - "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "abc123", - "method_code": "xyz789", - "method_title": "xyz789", - "price_excl_tax": Money, - "price_incl_tax": Money + "base64_encoded_data": "abc123", + "name": "xyz789", + "type": "abc123" } ``` -### SendEmailToFriendInput +### ProductMediaGalleryEntriesVideoContent -Defines the referenced product and the email sender and recipients. +Contains a link to a video file and basic information about the video. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | -| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | +| Field Name | Description | +|------------|-------------| +| `media_type` - [`String`](#string) | Must be external-video. | +| `video_description` - [`String`](#string) | A description of the video. | +| `video_metadata` - [`String`](#string) | Optional data about the video. | +| `video_provider` - [`String`](#string) | Describes the video source. | +| `video_title` - [`String`](#string) | The title of the video. | +| `video_url` - [`String`](#string) | The URL to the video. | #### Example ```json { - "product_id": 123, - "recipients": [SendEmailToFriendRecipientInput], - "sender": SendEmailToFriendSenderInput + "media_type": "abc123", + "video_description": "xyz789", + "video_metadata": "xyz789", + "video_provider": "abc123", + "video_title": "abc123", + "video_url": "xyz789" } ``` -### SendEmailToFriendOutput +### ProductPrice -Contains information about the sender and recipients. +Represents a product price. #### Fields | Field Name | Description | |------------|-------------| -| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | +| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `regular_price` - [`Money!`](#money) | The regular price of the product. | #### Example ```json { - "recipients": [SendEmailToFriendRecipient], - "sender": SendEmailToFriendSender + "discount": ProductDiscount, + "final_price": Money, + "fixed_product_taxes": [FixedProductTax], + "regular_price": Money } ``` -### SendEmailToFriendRecipient +### ProductPrices -An output object that contains information about the recipient. +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 Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | +| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | +| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | +| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | #### Example ```json { - "email": "xyz789", - "name": "xyz789" + "maximalPrice": Price, + "minimalPrice": Price, + "regularPrice": Price } ``` -### SendEmailToFriendRecipientInput +### ProductReview -Contains details about a recipient. +Contains details of a product review. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | +| Field Name | Description | +|------------|-------------| +| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](#string) | The date the review was created. | +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | +| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json { - "email": "abc123", - "name": "abc123" + "average_rating": 123.45, + "created_at": "abc123", + "nickname": "abc123", + "product": ProductInterface, + "ratings_breakdown": [ProductReviewRating], + "summary": "abc123", + "text": "abc123" } ``` -### SendEmailToFriendSender +### ProductReviewRating -An output object that contains information about the sender. +Contains data about a single aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json { - "email": "xyz789", - "message": "abc123", - "name": "xyz789" + "name": "abc123", + "value": "abc123" } ``` -### SendEmailToFriendSenderInput +### ProductReviewRatingInput -Contains details about the sender. +Contains the reviewer's rating for a single aspect of a review. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | +| `id` - [`String!`](#string) | An encoded rating ID. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | #### Example ```json { - "email": "xyz789", - "message": "xyz789", - "name": "xyz789" + "id": "abc123", + "value_id": "abc123" } ``` -### SendFriendConfiguration +### ProductReviewRatingMetadata -Contains details about the configuration of the Email to a Friend feature. +Contains details about a single aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | +| `id` - [`String!`](#string) | An encoded rating ID. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | #### Example ```json -{"enabled_for_customers": true, "enabled_for_guests": true} +{ + "id": "abc123", + "name": "abc123", + "values": [ProductReviewRatingValueMetadata] +} ``` -### SendNegotiableQuoteForReviewInput +### ProductReviewRatingValueMetadata -Specifies which negotiable quote to send for review. +Contains details about a single value in a product review. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Field Name | Description | +|------------|-------------| +| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | #### Example ```json { - "comment": NegotiableQuoteCommentInput, - "quote_uid": "4" + "value": "xyz789", + "value_id": "abc123" } ``` -### SendNegotiableQuoteForReviewOutput +### ProductReviewRatingsMetadata -Contains the negotiable quote. +Contains an array of metadata about each aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | #### Example ```json -{"quote": NegotiableQuote} +{"items": [ProductReviewRatingMetadata]} ``` -### SetBillingAddressOnCartInput +### ProductReviews -Sets the billing address. +Contains an array of product reviews. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | #### Example ```json { - "billing_address": BillingAddressInput, - "cart_id": "abc123" + "items": [ProductReview], + "page_info": SearchResultPageInfo } ``` -### SetBillingAddressOnCartOutput +### ProductStockStatus -Contains details about the cart after setting the billing address. +This enumeration states whether a product stock status is in stock or out of stock -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `IN_STOCK` | | +| `OUT_OF_STOCK` | | #### Example ```json -{"cart": Cart} +""IN_STOCK"" ``` -### SetGiftOptionsOnCartInput +### ProductTierPrices -Defines the gift options applied to the cart. +Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | +| Field Name | Description | +|------------|-------------| +| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json { - "cart_id": "abc123", - "gift_message": GiftMessageInput, - "gift_receipt_included": false, - "gift_wrapping_id": "4", - "printed_card_included": false + "customer_group_id": "xyz789", + "percentage_value": 123.45, + "qty": 987.65, + "value": 987.65, + "website_id": 987.65 } ``` -### SetGiftOptionsOnCartOutput +### ProductVideo -Contains the cart after gift options have been applied. +Contains information about a product video. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json -{"cart": Cart} +{ + "disabled": true, + "label": "abc123", + "position": 123, + "url": "xyz789", + "video_content": ProductMediaGalleryEntriesVideoContent +} ``` -### SetGuestEmailOnCartInput +### Products -Defines the guest email and cart. +Contains the results of a `products` query. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `email` - [`String!`](#string) | The email address of the guest. | +| Field Name | Description | +|------------|-------------| +| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](#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 ```json { - "cart_id": "abc123", - "email": "abc123" + "aggregations": [Aggregation], + "filters": [LayerFilter], + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "suggestions": [SearchSuggestion], + "total_count": 987 } ``` -### SetGuestEmailOnCartOutput +### PurchaseOrder -Contains details about the cart after setting the email of a guest. +Contains details about a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | +| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | +| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | +| `created_at` - [`String!`](#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | +| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | +| `number` - [`String!`](#string) | The purchase order number. | +| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | +| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | +| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | #### Example ```json -{"cart": Cart} +{ + "approval_flow": [PurchaseOrderRuleApprovalFlow], + "available_actions": ["REJECT"], + "comments": [PurchaseOrderComment], + "created_at": "abc123", + "created_by": Customer, + "history_log": [PurchaseOrderHistoryItem], + "number": "abc123", + "order": CustomerOrder, + "quote": Cart, + "status": "PENDING", + "uid": 4, + "updated_at": "abc123" +} ``` -### SetLineItemNoteOutput - -Contains the updated negotiable quote. +### PurchaseOrderAction -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `REJECT` | | +| `CANCEL` | | +| `VALIDATE` | | +| `APPROVE` | | +| `PLACE_ORDER` | | #### Example ```json -{"quote": NegotiableQuote} +""REJECT"" ``` -### SetNegotiableQuoteBillingAddressInput +### PurchaseOrderActionError -Sets the billing address. +Contains details about a failed action. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{ - "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": 4 -} +{"message": "xyz789", "type": "NOT_FOUND"} ``` -### SetNegotiableQuoteBillingAddressOutput +### PurchaseOrderApprovalFlowEvent -Contains the negotiable quote. +Contains details about a single event in the approval flow of the purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `message` - [`String`](#string) | A formatted message. | +| `name` - [`String`](#string) | The approver name. | +| `role` - [`String`](#string) | The approver role. | +| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | +| `updated_at` - [`String`](#string) | The date and time the event was updated. | #### Example ```json -{"quote": NegotiableQuote} +{ + "message": "xyz789", + "name": "abc123", + "role": "abc123", + "status": "PENDING", + "updated_at": "abc123" +} ``` -### SetNegotiableQuotePaymentMethodInput - -Defines the payment method of the specified negotiable quote. +### PurchaseOrderApprovalFlowItemStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVED` | | +| `REJECTED` | | #### Example ```json -{ - "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 -} +""PENDING"" ``` -### SetNegotiableQuotePaymentMethodOutput +### PurchaseOrderApprovalRule -Contains details about the negotiable quote after setting the payment method. +Contains details about a purchase order approval rule. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | +| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](#string) | The name of the purchase order approval rule. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | #### Example ```json -{"quote": NegotiableQuote} +{ + "applies_to_roles": [CompanyRole], + "approver_roles": [CompanyRole], + "condition": PurchaseOrderApprovalRuleConditionInterface, + "created_at": "abc123", + "created_by": "abc123", + "description": "abc123", + "name": "abc123", + "status": "ENABLED", + "uid": "4", + "updated_at": "abc123" +} ``` -### SetNegotiableQuoteShippingAddressInput +### PurchaseOrderApprovalRuleConditionAmount -Defines the shipping address to assign to the negotiable quote. +Contains approval rule condition details, including the amount to be evaluated. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | #### Example ```json { - "customer_address_id": 4, - "quote_uid": 4, - "shipping_addresses": [ - NegotiableQuoteShippingAddressInput - ] + "amount": Money, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN" } ``` -### SetNegotiableQuoteShippingAddressOutput +### PurchaseOrderApprovalRuleConditionInterface -Contains the negotiable quote. +Purchase order rule condition details. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | + +#### Possible Types + +| PurchaseOrderApprovalRuleConditionInterface Types | +|----------------| +| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | +| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | #### Example ```json -{"quote": NegotiableQuote} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} ``` -### SetNegotiableQuoteShippingMethodsInput - -Defines the shipping method to apply to the negotiable quote. +### PurchaseOrderApprovalRuleConditionOperator -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | +| Enum Value | Description | +|------------|-------------| +| `MORE_THAN` | | +| `LESS_THAN` | | +| `MORE_THAN_OR_EQUAL_TO` | | +| `LESS_THAN_OR_EQUAL_TO` | | #### Example ```json -{ - "quote_uid": "4", - "shipping_methods": [ShippingMethodInput] -} +""MORE_THAN"" ``` -### SetNegotiableQuoteShippingMethodsOutput +### PurchaseOrderApprovalRuleConditionQuantity -Contains the negotiable quote. +Contains approval rule condition details, including the quantity to be evaluated. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"quote": NegotiableQuote} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` -### SetNegotiableQuoteTemplateShippingAddressInput +### PurchaseOrderApprovalRuleInput -Defines the shipping address to assign to the negotiable quote template. +Defines a new purchase order approval rule. #### Input Fields | Input Field | Description | |-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](#string) | The purchase order approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": 4 + "applies_to": [4], + "approvers": [4], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "xyz789", + "name": "xyz789", + "status": "ENABLED" } ``` -### SetPaymentMethodAndPlaceOrderInput +### PurchaseOrderApprovalRuleMetadata -Applies a payment method to the quote. +Contains metadata that can be used to render rule edit forms. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Field Name | Description | +|------------|-------------| +| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example ```json { - "cart_id": "abc123", - "payment_method": PaymentMethodInput + "available_applies_to": [CompanyRole], + "available_condition_currencies": [AvailableCurrency], + "available_requires_approval_from": [CompanyRole] } ``` -### SetPaymentMethodOnCartInput - -Applies a payment method to the cart. +### PurchaseOrderApprovalRuleStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Enum Value | Description | +|------------|-------------| +| `ENABLED` | | +| `DISABLED` | | #### Example ```json -{ - "cart_id": "xyz789", - "payment_method": PaymentMethodInput -} +""ENABLED"" ``` -### SetPaymentMethodOnCartOutput - -Contains details about the cart after setting the payment method. +### PurchaseOrderApprovalRuleType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `GRAND_TOTAL` | | +| `SHIPPING_INCL_TAX` | | +| `NUMBER_OF_SKUS` | | #### Example ```json -{"cart": Cart} +""GRAND_TOTAL"" ``` -### SetShippingAddressesOnCartInput +### PurchaseOrderApprovalRules -Specifies an array of addresses to use for shipping. +Contains the approval rules that the customer can see. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | #### Example ```json { - "cart_id": "abc123", - "shipping_addresses": [ShippingAddressInput] + "items": [PurchaseOrderApprovalRule], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### SetShippingAddressesOnCartOutput +### PurchaseOrderComment -Contains details about the cart after setting the shipping addresses. +Contains details about a comment. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetShippingMethodsOnCartInput - -Applies one or shipping methods to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | +| `author` - [`Customer`](#customer) | The user who left the comment. | +| `created_at` - [`String!`](#string) | The date and time when the comment was created. | +| `text` - [`String!`](#string) | The text of the comment. | +| `uid` - [`ID!`](#id) | A unique identifier of the comment. | #### Example ```json { - "cart_id": "xyz789", - "shipping_methods": [ShippingMethodInput] + "author": Customer, + "created_at": "abc123", + "text": "xyz789", + "uid": 4 } ``` -### SetShippingMethodsOnCartOutput - -Contains details about the cart after setting the shipping methods. +### PurchaseOrderErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | #### Example ```json -{"cart": Cart} +""NOT_FOUND"" ``` -### ShareGiftRegistryInviteeInput +### PurchaseOrderHistoryItem -Defines a gift registry invitee. +Contains details about a status change. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the gift registry invitee. | -| `name` - [`String!`](#string) | The name of the gift registry invitee. | +| Field Name | Description | +|------------|-------------| +| `activity` - [`String!`](#string) | The activity type of the event. | +| `created_at` - [`String!`](#string) | The date and time when the event happened. | +| `message` - [`String!`](#string) | The message representation of the event. | +| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "email": "xyz789", - "name": "abc123" + "activity": "xyz789", + "created_at": "abc123", + "message": "xyz789", + "uid": 4 } ``` -### ShareGiftRegistryOutput +### PurchaseOrderRuleApprovalFlow -Contains the results of a request to share a gift registry. +Contains details about approval roles applied to the purchase order and status changes. #### Fields | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | +| `rule_name` - [`String!`](#string) | The name of the applied rule. | #### Example ```json -{"is_shared": true} +{ + "events": [PurchaseOrderApprovalFlowEvent], + "rule_name": "xyz789" +} ``` -### ShareGiftRegistrySenderInput - -Defines the sender of an invitation to view a gift registry. +### PurchaseOrderStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `message` - [`String!`](#string) | A brief message from the sender. | -| `name` - [`String!`](#string) | The sender of the gift registry invitation. | +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVAL_REQUIRED` | | +| `APPROVED` | | +| `ORDER_IN_PROGRESS` | | +| `ORDER_PLACED` | | +| `ORDER_FAILED` | | +| `REJECTED` | | +| `CANCELED` | | +| `APPROVED_PENDING_PAYMENT` | | #### Example ```json -{ - "message": "xyz789", - "name": "xyz789" -} +""PENDING"" ``` -### ShipBundleItemsEnum +### PurchaseOrders -Defines whether bundle items must be shipped together. +Contains a list of purchase orders. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `TOGETHER` | | -| `SEPARATELY` | | +| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | #### Example ```json -""TOGETHER"" +{ + "items": [PurchaseOrder], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### ShipmentItem +### PurchaseOrdersActionInput -#### Fields +Defines which purchase orders to act on. -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | #### Example ```json -{ - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 -} +{"purchase_order_uids": [4]} ``` -### ShipmentItemInterface +### PurchaseOrdersActionOutput -Order shipment item details. +Returns a list of updated purchase orders and any error messages. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Possible Types - -| ShipmentItemInterface Types | -|----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | -| [`ShipmentItem`](#shipmentitem) | +| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | #### Example ```json { - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "errors": [PurchaseOrderActionError], + "purchase_orders": [PurchaseOrder] } ``` -### ShipmentTracking +### PurchaseOrdersFilterInput -Contains order shipment tracking details. +Defines the criteria to use to filter the list of purchase orders. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | -| `number` - [`String`](#string) | The tracking number of the order shipment. | -| `title` - [`String!`](#string) | The shipment tracking title. | +| Input Field | Description | +|-------------|-------------| +| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | #### Example ```json { - "carrier": "abc123", - "number": "xyz789", - "title": "xyz789" + "company_purchase_orders": true, + "created_date": FilterRangeTypeInput, + "require_my_approval": true, + "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-4.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md similarity index 53% rename from src/pages/includes/autogenerated/graphql-api-2-4-8-types-4.md rename to src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md index f4457b434..a6635af25 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-4.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-q-s.md @@ -1,1801 +1,2367 @@ -### ShippingAddressInput +## Types -Defines a single shipping address. +### QuoteItemsSortInput + +Specifies the field to use for sorting quote items #### Input Fields | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | +| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | +| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | #### Example ```json -{ - "address": CartAddressInput, - "customer_address_id": 123, - "customer_notes": "xyz789", - "pickup_location_code": "xyz789" -} +{"field": "ITEM_ID", "order": "ASC"} ``` -### ShippingCartAddress +### QuoteTemplateLineItemNoteInput -Contains shipping addresses and methods. +Sets quote item note. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. | -| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `same_as_billing` - [`Boolean!`](#boolean) | Indicates whether the shipping address is same as billing address. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`String!`](#string) | The unique id of the customer address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `note` - [`String`](#string) | The note text to be added. | +| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "available_shipping_methods": [AvailableShippingMethod], - "cart_items": [CartItemQuantity], - "cart_items_v2": [CartItemInterface], - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_notes": "abc123", - "fax": "xyz789", - "firstname": "abc123", - "id": 987, - "items_weight": 987.65, - "lastname": "xyz789", - "middlename": "xyz789", - "pickup_location_code": "abc123", - "postcode": "abc123", - "prefix": "abc123", - "region": CartAddressRegion, - "same_as_billing": false, - "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": "abc123", - "vat_id": "abc123" + "item_id": 4, + "note": "xyz789", + "templateId": "4" } ``` -### ShippingDiscount +### QuoteTemplateNotificationMessage -Defines an individual shipping discount. This discount can be applied to shipping. +Contains a notification message for a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `message` - [`String!`](#string) | The notification message. | +| `type` - [`String!`](#string) | The type of notification message. | #### Example ```json -{"amount": Money} +{ + "message": "xyz789", + "type": "xyz789" +} ``` -### ShippingHandling - -Contains details about shipping and handling costs. +### ReCaptchaConfigOutput #### Fields | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | -| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](#money) | The total amount for shipping. | +| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | +| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | #### Example ```json { - "amount_excluding_tax": Money, - "amount_including_tax": Money, - "discounts": [ShippingDiscount], - "taxes": [TaxItem], - "total_amount": Money + "configurations": ReCaptchaConfiguration, + "is_enabled": true } ``` -### ShippingMethodInput +### ReCaptchaConfiguration -Defines the shipping carrier and method. +Contains reCAPTCHA form configuration details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | -| `method_code` - [`String!`](#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. | +| Field Name | Description | +|------------|-------------| +| `badge_position` - [`String`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `re_captcha_type` - [`ReCaptchaTypeEmum!`](#recaptchatypeemum) | | +| `technical_failure_message` - [`String!`](#string) | The message that appears when reCaptcha fails. | +| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | +| `validation_failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | #### Example ```json { - "carrier_code": "xyz789", - "method_code": "xyz789" + "badge_position": "xyz789", + "language_code": "abc123", + "minimum_score": 123.45, + "re_captcha_type": "INVISIBLE", + "technical_failure_message": "xyz789", + "theme": "xyz789", + "validation_failure_message": "xyz789", + "website_key": "abc123" } ``` -### SimpleCartItem +### ReCaptchaConfigurationV3 -An implementation for simple product cart items. +Contains reCAPTCHA V3-Invisible configuration details. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | +| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | #### Example ```json { - "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, - "min_qty": 123.45, - "not_available_message": "abc123", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "badge_position": "xyz789", + "failure_message": "xyz789", + "forms": ["PLACE_ORDER"], + "is_enabled": true, + "language_code": "xyz789", + "minimum_score": 123.45, + "theme": "xyz789", + "website_key": "xyz789" } ``` -### SimpleProduct - -Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. +### ReCaptchaFormEnum -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `PLACE_ORDER` | | +| `CONTACT` | | +| `CUSTOMER_LOGIN` | | +| `CUSTOMER_FORGOT_PASSWORD` | | +| `CUSTOMER_CREATE` | | +| `CUSTOMER_EDIT` | | +| `NEWSLETTER` | | +| `PRODUCT_REVIEW` | | +| `SENDFRIEND` | | +| `BRAINTREE` | | +| `RESEND_CONFIRMATION_EMAIL` | | #### Example ```json -{ - "activity": "abc123", - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "category_gear": "xyz789", - "climate": "abc123", - "collar": "xyz789", - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "eco_collection": 123, - "erin_recommends": 123, - "features_bags": "xyz789", - "format": 123, - "gender": "xyz789", - "gift_message_available": false, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 987, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 123, - "material": "abc123", - "max_sale_qty": 123.45, - "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": "xyz789", - "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": 123, - "quantity": 123.45, - "rating_summary": 987.65, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "reviews": ProductReviews, - "rules": [CatalogRule], - "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": "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": 123.45, - "tier_prices": [ProductTierPrices], - "type": "CMS_PAGE", - "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], - "weight": 987.65 -} +""PLACE_ORDER"" ``` -### SimpleProductCartItemInput - -Defines a single product to add to the cart. +### ReCaptchaTypeEmum -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| Enum Value | Description | +|------------|-------------| +| `INVISIBLE` | | +| `RECAPTCHA` | | +| `RECAPTCHA_V3` | | #### Example ```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} +""INVISIBLE"" ``` -### SimpleRequisitionListItem - -Contains details about simple products added to a requisition list. +### Region #### Fields | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | +| `id` - [`Int`](#int) | The unique ID for a `Region` object. | +| `name` - [`String`](#string) | The name of the region, such as Texas. | #### Example ```json { - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "code": "xyz789", + "id": 123, + "name": "abc123" } ``` -### SimpleWishlistItem +### RemoveCouponFromCartInput -Contains a simple product wish list item. +Specifies the cart from which to remove a coupon. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### RemoveCouponFromCartOutput + +Contains details about the cart after removing a coupon. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveCouponsFromCartInput + +Remove coupons from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#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 ```json { - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 + "cart_id": "xyz789", + "coupon_codes": ["abc123"] } ``` -### SmartButtonMethodInput +### RemoveGiftCardFromCartInput -Smart button payment inputs +Defines the input required to run the `removeGiftCardFromCart` mutation. #### Input Fields | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "abc123", - "paypal_order_id": "xyz789" + "cart_id": "xyz789", + "gift_card_code": "abc123" } ``` -### SmartButtonsConfig +### RemoveGiftCardFromCartOutput + +Defines the possible output for the `removeGiftCardFromCart` mutation. #### Fields | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | #### Example ```json -{ - "button_styles": ButtonStyles, - "code": "abc123", - "display_message": false, - "display_venmo": true, - "is_visible": false, - "message_styles": MessageStyles, - "payment_intent": "abc123", - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "xyz789" -} +{"cart": Cart} ``` -### SortEnum +### RemoveGiftRegistryItemsOutput -Indicates whether to return results in ascending or descending order. +Contains the results of a request to remove an item from a gift registry. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ASC` | | -| `DESC` | | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | #### Example ```json -""ASC"" +{"gift_registry": GiftRegistry} ``` -### SortField +### RemoveGiftRegistryOutput -Defines a possible sort field. +Contains the results of a request to delete a gift registry. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label of the sort field. | -| `value` - [`String`](#string) | The attribute code of the sort field. | +| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | + +#### Example + +```json +{"success": true} +``` + + + +### RemoveGiftRegistryRegistrantsOutput + +Contains the results of a request to delete a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveItemFromCartInput + +Specifies which items to remove from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | #### Example ```json { - "label": "abc123", - "value": "abc123" + "cart_id": "abc123", + "cart_item_id": 987, + "cart_item_uid": 4 } ``` -### SortFields +### RemoveItemFromCartOutput -Contains a default value for sort fields and all available sort fields. +Contains details about the cart after removing an item. #### Fields | Field Name | Description | |------------|-------------| -| `default` - [`String`](#string) | The default sort field value. | -| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | +| `cart` - [`Cart!`](#cart) | The cart after removing an item. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveNegotiableQuoteItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"quote_item_uids": ["4"], "quote_uid": 4} +``` + + + +### RemoveNegotiableQuoteItemsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RemoveNegotiableQuoteTemplateItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"item_uids": [4], "template_id": 4} +``` + + + +### RemoveProductsFromCompareListInput + +Defines which products to remove from a compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": ["4"], "uid": 4} +``` + + + +### RemoveProductsFromWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | #### Example ```json { - "default": "abc123", - "options": [SortField] + "user_errors": [WishListUserInputError], + "wishlist": Wishlist } ``` -### SortQuoteItemsEnum +### RemoveReturnTrackingInput -Specifies the field to use for sorting quote items +Defines the tracking information to delete. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `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` | | +| Input Field | Description | +|-------------|-------------| +| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | #### Example ```json -""ITEM_ID"" +{"return_shipping_tracking_uid": 4} ``` -### StoreConfig +### RemoveReturnTrackingOutput -Contains information about a store's configuration. +Contains the response after deleting tracking information. #### Fields | Field Name | Description | |------------|-------------| -| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `<body>` tag. | -| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | -| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | -| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | -| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | -| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | -| `base_currency_code` - [`String`](#string) | The base currency code. | -| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | -| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | -| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | -| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | -| `braintree_3dsecure_allowspecific` - [`Boolean`](#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | -| `braintree_3dsecure_always_request_3ds` - [`Boolean`](#boolean) | Braintree 3D Secure, always request 3D Secure flag. | -| `braintree_3dsecure_specificcountry` - [`String`](#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`](#string) | Braintree 3D Secure, threshold above which 3D Secure should be requested. | -| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](#boolean) | Braintree 3D Secure enabled/active status. | -| `braintree_ach_direct_debit_vault_active` - [`Boolean`](#boolean) | Braintree ACH vault status. | -| `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | -| `braintree_applepay_vault_active` - [`Boolean`](#boolean) | Braintree Apple Pay vault status. | -| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `braintree_cc_vault_cvv` - [`Boolean`](#boolean) | Braintree cc vault CVV re-verification enabled status. | -| `braintree_environment` - [`String`](#string) | Braintree environment. | -| `braintree_googlepay_btn_color` - [`String`](#string) | Braintree Google Pay button color. | -| `braintree_googlepay_cctypes` - [`String`](#string) | Braintree Google Pay Card types supported. | -| `braintree_googlepay_merchant_id` - [`String`](#string) | Braintree Google Pay merchant ID. | -| `braintree_googlepay_vault_active` - [`Boolean`](#boolean) | Braintree Google Pay vault status. | -| `braintree_local_payment_allowed_methods` - [`String`](#string) | Braintree Local Payment Methods allowed payment methods. | -| `braintree_local_payment_fallback_button_text` - [`String`](#string) | Braintree Local Payment Methods fallback button text. | -| `braintree_local_payment_redirect_on_fail` - [`String`](#string) | Braintree Local Payment Methods redirect URL on failed payment. | -| `braintree_merchant_account_id` - [`String`](#string) | Braintree Merchant Account ID. | -| `braintree_paypal_button_location_cart_type_credit_color` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_credit_label` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | -| `braintree_paypal_button_location_cart_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style layout. | -| `braintree_paypal_button_location_cart_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo. | -| `braintree_paypal_button_location_cart_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo position. | -| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | -| `braintree_paypal_button_location_cart_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | -| `braintree_paypal_button_location_cart_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | -| `braintree_paypal_button_location_cart_type_paypal_color` - [`String`](#string) | Braintree PayPal mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_paypal_label` - [`String`](#string) | Braintree PayPal mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_paypal_shape` - [`String`](#string) | Braintree PayPal mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal mini-cart & cart button show. | -| `braintree_paypal_button_location_checkout_type_credit_color` - [`String`](#string) | Braintree PayPal Credit checkout button style color. | -| `braintree_paypal_button_location_checkout_type_credit_label` - [`String`](#string) | Braintree PayPal Credit checkout button style label. | -| `braintree_paypal_button_location_checkout_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit checkout button show status. | -| `braintree_paypal_button_location_checkout_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style layout. | -| `braintree_paypal_button_location_checkout_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo. | -| `braintree_paypal_button_location_checkout_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo position. | -| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging checkout show status. | -| `braintree_paypal_button_location_checkout_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | -| `braintree_paypal_button_location_checkout_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later checkout button style color. | -| `braintree_paypal_button_location_checkout_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later checkout button style label. | -| `braintree_paypal_button_location_checkout_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later checkout button show status. | -| `braintree_paypal_button_location_checkout_type_paypal_color` - [`String`](#string) | Braintree PayPal checkout button style color. | -| `braintree_paypal_button_location_checkout_type_paypal_label` - [`String`](#string) | Braintree PayPal checkout button style label. | -| `braintree_paypal_button_location_checkout_type_paypal_shape` - [`String`](#string) | Braintree PayPal checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal checkout button show. | -| `braintree_paypal_button_location_productpage_type_credit_color` - [`String`](#string) | Braintree PayPal Credit PDP button style color. | -| `braintree_paypal_button_location_productpage_type_credit_label` - [`String`](#string) | Braintree PayPal Credit PDP button style label. | -| `braintree_paypal_button_location_productpage_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit PDP button show status. | -| `braintree_paypal_button_location_productpage_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style layout. | -| `braintree_paypal_button_location_productpage_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo. | -| `braintree_paypal_button_location_productpage_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo position. | -| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging PDP show status. | -| `braintree_paypal_button_location_productpage_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style text color. | -| `braintree_paypal_button_location_productpage_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later PDP button style color. | -| `braintree_paypal_button_location_productpage_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later PDP button style label. | -| `braintree_paypal_button_location_productpage_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later PDP button show status. | -| `braintree_paypal_button_location_productpage_type_paypal_color` - [`String`](#string) | Braintree PayPal PDP button style color. | -| `braintree_paypal_button_location_productpage_type_paypal_label` - [`String`](#string) | Braintree PayPal PDP button style label. | -| `braintree_paypal_button_location_productpage_type_paypal_shape` - [`String`](#string) | Braintree PayPal PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal PDP button show. | -| `braintree_paypal_credit_uk_merchant_name` - [`String`](#string) | Braintree PayPal Credit Merchant Name on the FCA Register. | -| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](#boolean) | Should display Braintree PayPal in mini-cart & cart? | -| `braintree_paypal_merchant_country` - [`String`](#string) | Braintree PayPal merchant's country. | -| `braintree_paypal_merchant_name_override` - [`String`](#string) | Braintree PayPal override for Merchant Name. | -| `braintree_paypal_require_billing_address` - [`Boolean`](#boolean) | Does Braintree PayPal require the customer's billing address? | -| `braintree_paypal_send_cart_line_items` - [`Boolean`](#boolean) | Does Braintree PayPal require the order line items? | -| `braintree_paypal_vault_active` - [`Boolean`](#boolean) | Braintree PayPal vault status. | -| `cart_expires_in_days` - [`Int`](#int) | checkout/cart/delete_quote_after: quote lifetime in days. | -| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | -| `cart_printed_card` - [`String`](#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`](#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`](#string) | The default sort order of the search results list. | -| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | -| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | -| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | -| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | -| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | -| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | -| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | -| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | -| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | -| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | -| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | -| `configurable_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | -| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | -| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | -| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | -| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | -| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | -| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | -| `default_description` - [`String`](#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`](#string) | The default display currency code. | -| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | -| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | -| `demonotice` - [`Int`](#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!`](#int) | Configuration data from tax/display/type | -| `display_shipping_prices` - [`Int!`](#int) | Configuration data from tax/display/shipping | -| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | -| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | -| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](#boolean) | Configuration data from tax/weee/apply_vat | -| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](#int) | Configuration data from tax/weee/display_email | -| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](#int) | Configuration data from tax/weee/display_list | -| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](#int) | Configuration data from tax/weee/display_sales | -| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](#int) | Configuration data from tax/weee/display | -| `fixed_product_taxes_enable` - [`Boolean!`](#boolean) | Configuration data from tax/weee/enable | -| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](#boolean) | Configuration data from tax/weee/include_in_subtotal | -| `front` - [`String`](#string) | The landing page that is associated with the base URL. | -| `graphql_share_all_customer_groups` - [`Boolean!`](#boolean) | Configuration data from customer/account_information/graphql_share_all_customer_groups | -| `graphql_share_customer_group` - [`Boolean!`](#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | -| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | -| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | -| `grouped_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | -| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `<head>` tag. | -| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | -| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | -| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_checkout_agreements_enabled` - [`Boolean!`](#boolean) | Configuration data from checkout/options/enable_agreements | -| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | -| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | -| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | -| `list_mode` - [`String`](#string) | The format of the search results list. | -| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | -| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | -| `locale` - [`String`](#string) | The store locale. | -| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | -| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | -| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | -| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | -| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | -| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | -| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | -| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | -| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | -| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | -| `max_items_in_order_summary` - [`Int`](#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | -| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | -| `minicart_display` - [`Boolean`](#boolean) | checkout/sidebar/display: whether to display the minicart or not. | -| `minicart_max_items` - [`Int`](#int) | checkout/sidebar/count: maximum number of items to show in minicart. | -| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | -| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | -| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | -| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | -| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | -| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/full_summary | -| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/grandtotal | -| `orders_invoices_credit_memos_display_price` - [`Int!`](#int) | Configuration data from tax/sales_display/price | -| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](#int) | Configuration data from tax/sales_display/shipping | -| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](#int) | Configuration data from tax/sales_display/subtotal | -| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/zero_tax | -| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | -| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. *(Deprecated: Use printed_card_priceV2 instead)* | -| `printed_card_priceV2` - [`Money`](#money) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | -| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | -| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | -| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | -| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | -| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | -| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | -| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | -| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | -| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | -| `share_all_catalog_rules` - [`Boolean!`](#boolean) | Configuration data from catalog/rule/share_all_catalog_rules | -| `share_all_sales_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_all_sales_rule | -| `share_applied_catalog_rules` - [`Boolean!`](#boolean) | Configuration data from catalog/rule/share_applied_catalog_rules | -| `share_applied_sales_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_applied_sales_rule | -| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | -| `store_group_name` - [`String`](#string) | The label assigned to the store group. | -| `store_name` - [`String`](#string) | The label assigned to the store view. | -| `store_sort_order` - [`Int`](#int) | The store view sort order. | -| `timezone` - [`String`](#string) | The time zone of the store. | -| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | -| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | -| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | -| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](#id) | The unique ID for the website. | -| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | -| `website_name` - [`String`](#string) | The label assigned to the website. | -| `weight_unit` - [`String`](#string) | The unit of weight. | -| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | -| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | -| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | -| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | +| `return` - [`Return`](#return) | Contains details about the modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### RemoveRewardPointsFromCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveStoreCreditFromCartInput + +Defines the input required to run the `removeStoreCreditFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### RemoveStoreCreditFromCartOutput + +Defines the possible output for the `removeStoreCreditFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RenameNegotiableQuoteInput + +Sets new name for a negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | +| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | +| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | + +#### Example + +```json +{ + "quote_comment": "abc123", + "quote_name": "abc123", + "quote_uid": 4 +} +``` + + + +### RenameNegotiableQuoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### ReorderItemsOutput + +Contains the cart and any errors after adding products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | + +#### Example + +```json +{ + "cart": Cart, + "userInputErrors": [CheckoutUserInputError] +} +``` + + + +### RequestGuestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `token` - [`String!`](#string) | Order token. | + +#### Example + +```json +{ + "comment_text": "abc123", + "contact_email": "abc123", + "items": [RequestReturnItemInput], + "token": "xyz789" +} +``` + + + +### RequestNegotiableQuoteInput + +Defines properties of a negotiable quote request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | +| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | + +#### Example + +```json +{ + "cart_id": "4", + "comment": NegotiableQuoteCommentInput, + "is_draft": true, + "quote_name": "xyz789" +} +``` + + + +### RequestNegotiableQuoteOutput + +Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RequestNegotiableQuoteTemplateInput + +Defines properties of a negotiable quote template request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | + +#### Example + +```json +{"cart_id": 4} +``` + + + +### RequestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | + +#### Example + +```json +{ + "comment_text": "xyz789", + "contact_email": "xyz789", + "items": [RequestReturnItemInput], + "order_uid": "4" +} +``` + + + +### RequestReturnItemInput + +Contains details about an item to be returned. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | +| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 + +```json +{ + "entered_custom_attributes": [ + EnteredCustomAttributeInput + ], + "order_item_uid": "4", + "quantity_to_return": 987.65, + "selected_custom_attributes": [ + SelectedCustomAttributeInput + ] +} +``` + + + +### RequestReturnOutput + +Contains the response to a return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about a single return request. | +| `returns` - [`Returns`](#returns) | An array of return requests. | + +#### Example + +```json +{ + "return": Return, + "returns": Returns +} +``` + + + +### RequisitionList + +Defines the contents of a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `description` - [`String`](#string) | Optional text that describes the requisition list. | +| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | +| `items_count` - [`Int!`](#int) | The number of items in the list. | +| `name` - [`String!`](#string) | The requisition list name. | +| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | + +#### Example + +```json +{ + "description": "abc123", + "items": RequistionListItems, + "items_count": 987, + "name": "abc123", + "uid": "4", + "updated_at": "abc123" +} +``` + + + +### RequisitionListFilterInput + +Defines requisition list filters. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | + +#### Example + +```json +{ + "name": FilterMatchTypeInput, + "uids": FilterEqualTypeInput +} +``` + + + +### RequisitionListItemInterface + +The interface for requisition list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Possible Types + +| RequisitionListItemInterface Types | +|----------------| +| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | +| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### RequisitionListItemsInput + +Defines the items to add. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | +| `quantity` - [`Float`](#float) | The quantity of the product to add. | +| `selected_options` - [`[String]`](#string) | Selected option IDs. | +| `sku` - [`String!`](#string) | The product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 987.65, + "selected_options": ["xyz789"], + "sku": "xyz789" +} +``` + + + +### RequisitionLists + +Defines customer requisition lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The number of returned requisition lists. | + +#### Example + +```json +{ + "items": [RequisitionList], + "page_info": SearchResultPageInfo, + "total_count": 987 +} +``` + + + +### RequistionListItems + +Contains an array of items added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_pages` - [`Int!`](#int) | The number of pages returned. | + +#### Example + +```json +{ + "items": [RequisitionListItemInterface], + "page_info": SearchResultPageInfo, + "total_pages": 987 +} +``` + + + +### Return + +Contains details about a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | +| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | +| `created_at` - [`String!`](#string) | The date the return was requested. | +| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | +| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | +| `number` - [`String!`](#string) | A human-readable return number. | +| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | +| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | +| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | +| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "available_shipping_carriers": [ReturnShippingCarrier], + "comments": [ReturnComment], + "created_at": "abc123", + "customer": ReturnCustomer, + "items": [ReturnItem], + "number": "xyz789", + "order": CustomerOrder, + "shipping": ReturnShipping, + "status": "PENDING", + "uid": "4" +} +``` + + + +### ReturnComment + +Contains details about a return comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author_name` - [`String!`](#string) | The name or author who posted the comment. | +| `created_at` - [`String!`](#string) | The date and time the comment was posted. | +| `text` - [`String!`](#string) | The contents of the comment. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | + +#### Example + +```json +{ + "author_name": "abc123", + "created_at": "xyz789", + "text": "abc123", + "uid": "4" +} +``` + + + +### ReturnCustomAttribute + +Contains details about a `ReturnCustomerAttribute` object. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the attribute. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": "4", + "value": "abc123" +} +``` + + + +### ReturnCustomer + +The customer information for the return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the customer. | +| `firstname` - [`String`](#string) | The first name of the customer. | +| `lastname` - [`String`](#string) | The last name of the customer. | + +#### Example + +```json +{ + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### ReturnItem + +Contains details about a product being returned. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. *(Deprecated: Use custom_attributesV2 instead.)* | +| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | +| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | + +#### Example + +```json +{ + "custom_attributes": [ReturnCustomAttribute], + "custom_attributesV2": [AttributeValueInterface], + "order_item": OrderItemInterface, + "quantity": 987.65, + "request_quantity": 987.65, + "status": "PENDING", + "uid": 4 +} +``` + + + +### ReturnItemAttributeMetadata + +Return Item attribute metadata. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | + +#### Example + +```json +{ + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": false, + "is_unique": false, + "label": "xyz789", + "multiline_count": 123, + "options": [CustomAttributeOptionInterface], + "sort_order": 123, + "validate_rules": [ValidationRule] +} +``` + + + +### ReturnItemStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `RECEIVED` | | +| `APPROVED` | | +| `REJECTED` | | +| `DENIED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### ReturnShipping + +Contains details about the return shipping address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | +| `tracking` - [`[ReturnShippingTracking]`](#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. | + +#### Example + +```json +{ + "address": ReturnShippingAddress, + "tracking": [ReturnShippingTracking] +} +``` + + + +### ReturnShippingAddress + +Contains details about the shipping address used for receiving returned items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city for product returns. | +| `contact_name` - [`String`](#string) | The merchant's contact person. | +| `country` - [`Country!`](#country) | An object that defines the country for product returns. | +| `postcode` - [`String!`](#string) | The postal code for product returns. | +| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | +| `street` - [`[String]!`](#string) | The street address for product returns. | +| `telephone` - [`String`](#string) | The telephone number for product returns. | + +#### Example + +```json +{ + "city": "abc123", + "contact_name": "xyz789", + "country": Country, + "postcode": "xyz789", + "region": Region, + "street": ["xyz789"], + "telephone": "abc123" +} +``` + + + +### ReturnShippingCarrier + +Contains details about the carrier on a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the shipping carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": "4" +} +``` + + + +### ReturnShippingTracking + +Contains shipping and tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | +| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | +| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | + +#### Example + +```json +{ + "carrier": ReturnShippingCarrier, + "status": ReturnShippingTrackingStatus, + "tracking_number": "abc123", + "uid": 4 +} +``` + + + +### ReturnShippingTrackingStatus + +Contains the status of a shipment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `text` - [`String!`](#string) | Text that describes the status. | +| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | + +#### Example + +```json +{"text": "xyz789", "type": "INFORMATION"} +``` + + + +### ReturnShippingTrackingStatusType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INFORMATION` | | +| `ERROR` | | + +#### Example + +```json +""INFORMATION"" +``` + + + +### ReturnStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `UNCONFIRMED` | | +| `AUTHORIZED` | | +| `PARTIALLY_AUTHORIZED` | | +| `RECEIVED` | | +| `PARTIALLY_RECEIVED` | | +| `APPROVED` | | +| `PARTIALLY_APPROVED` | | +| `REJECTED` | | +| `PARTIALLY_REJECTED` | | +| `DENIED` | | +| `PROCESSED_AND_CLOSED` | | +| `CLOSED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### Returns + +Contains a list of customer return requests. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Return]`](#return) | A list of return requests. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The total number of return requests. | #### Example ```json { - "absolute_footer": "xyz789", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "abc123", - "allow_order": "abc123", - "allow_printed_card": "xyz789", - "autocomplete_on_storefront": true, - "base_currency_code": "abc123", - "base_link_url": "xyz789", - "base_media_url": "abc123", - "base_static_url": "xyz789", - "base_url": "abc123", - "braintree_3dsecure_allowspecific": true, - "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": true, - "braintree_applepay_merchant_name": "xyz789", - "braintree_applepay_vault_active": false, - "braintree_cc_vault_active": "xyz789", - "braintree_cc_vault_cvv": false, - "braintree_environment": "abc123", - "braintree_googlepay_btn_color": "xyz789", - "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": "abc123", - "braintree_paypal_button_location_cart_type_credit_color": "xyz789", - "braintree_paypal_button_location_cart_type_credit_label": "xyz789", - "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": "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": "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": false, - "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": "abc123", - "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": "xyz789", - "braintree_paypal_button_location_checkout_type_credit_shape": "xyz789", - "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": "abc123", - "braintree_paypal_button_location_checkout_type_messaging_show": true, - "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_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": false, - "braintree_paypal_button_location_productpage_type_credit_color": "xyz789", - "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": false, - "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": 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": "xyz789", - "braintree_paypal_button_location_productpage_type_paylater_shape": "xyz789", - "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": false, - "braintree_paypal_merchant_country": "abc123", - "braintree_paypal_merchant_name_override": "abc123", - "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": "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": false, - "check_money_order_enabled": false, - "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": "abc123", - "check_money_order_payment_from_specific_countries": "xyz789", - "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", - "cms_home_page": "abc123", - "cms_no_cookies": "abc123", - "cms_no_route": "abc123", - "code": "abc123", - "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, - "copyright": "xyz789", - "countries_with_required_region": "xyz789", - "create_account_confirmation": true, - "customer_access_token_lifetime": 987.65, - "default_country": "abc123", - "default_description": "xyz789", - "default_display_currency_code": "xyz789", - "default_keywords": "xyz789", - "default_title": "abc123", - "demonotice": 987, - "display_product_prices_in_catalog": 987, - "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": 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": false, - "fixed_product_taxes_include_fpt_in_subtotal": false, - "front": "xyz789", - "graphql_share_all_customer_groups": false, - "graphql_share_customer_group": false, - "grid_per_page": 987, - "grid_per_page_values": "xyz789", - "grouped_product_image": "ITSELF", - "head_includes": "abc123", - "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", - "id": 123, - "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": true, - "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", - "list_per_page": 123, - "list_per_page_values": "xyz789", - "locale": "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": "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": "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": true, - "minicart_max_items": 123, - "minimum_password_length": "abc123", - "newsletter_enabled": false, - "no_route": "abc123", - "optional_zip_countries": "xyz789", - "order_cancellation_enabled": false, - "order_cancellation_reasons": [CancellationReason], - "orders_invoices_credit_memos_display_full_summary": true, - "orders_invoices_credit_memos_display_grandtotal": false, - "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_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": 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": "xyz789", - "secure_base_link_url": "abc123", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", - "send_friend": SendFriendConfiguration, - "share_all_catalog_rules": true, - "share_all_sales_rule": true, - "share_applied_catalog_rules": true, - "share_applied_sales_rule": false, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 987, - "shopping_cart_display_shipping": 987, - "shopping_cart_display_subtotal": 123, - "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, - "show_cms_breadcrumbs": 987, - "store_code": "4", - "store_group_code": 4, - "store_group_name": "abc123", - "store_name": "xyz789", - "store_sort_order": 123, - "timezone": "xyz789", - "title_prefix": "abc123", - "title_separator": "abc123", - "title_suffix": "xyz789", - "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": false, - "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "abc123", - "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "xyz789" + "items": [Return], + "page_info": SearchResultPageInfo, + "total_count": 987 +} +``` + + + +### RevokeCustomerTokenOutput + +Contains the result of a request to revoke a customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | + +#### Example + +```json +{"result": true} +``` + + + +### RewardPoints + +Contains details about a customer's reward points. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | +| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | +| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "balance_history": [RewardPointsBalanceHistoryItem], + "exchange_rates": RewardPointsExchangeRates, + "subscription_status": RewardPointsSubscriptionStatus +} +``` + + + +### RewardPointsAmount + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `money` - [`Money!`](#money) | The reward points amount in store currency. | +| `points` - [`Float!`](#float) | The reward points amount in points. | + +#### Example + +```json +{"money": Money, "points": 123.45} +``` + + + +### RewardPointsBalanceHistoryItem + +Contain details about the reward points transaction. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | +| `change_reason` - [`String!`](#string) | The reason the balance changed. | +| `date` - [`String!`](#string) | The date of the transaction. | +| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "change_reason": "xyz789", + "date": "abc123", + "points_change": 123.45 +} +``` + + + +### RewardPointsExchangeRates + +Lists the reward points exchange rates. The values depend on the customer group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | +| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | + +#### Example + +```json +{ + "earning": RewardPointsRate, + "redemption": RewardPointsRate } ``` -### StorefrontProperties +### RewardPointsRate + +Contains details about customer's reward points rate. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency_amount` - [`Float!`](#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!`](#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 + +```json +{"currency_amount": 123.45, "points": 987.65} +``` + + + +### RewardPointsSubscriptionStatus -Indicates where an attribute can be displayed. +Indicates whether the customer subscribes to reward points emails. #### Fields | Field Name | Description | |------------|-------------| -| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | +| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | +| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | #### Example ```json { - "position": 987, - "use_in_layered_navigation": "NO", - "use_in_product_listing": false, - "use_in_search_results_layered_navigation": false, - "visible_on_catalog_pages": false + "balance_updates": "SUBSCRIBED", + "points_expiration_notifications": "SUBSCRIBED" } ``` -### String +### RewardPointsSubscriptionStatusesEnum -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. +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUBSCRIBED` | | +| `NOT_SUBSCRIBED` | | #### Example ```json -"abc123" +""SUBSCRIBED"" ``` -### SubmitNegotiableQuoteTemplateForReviewInput +### RoutableInterface -Specifies the quote template properties to update. +Routable entities serve as the model for a rendered page. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | -| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| Field Name | Description | +|------------|-------------| +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Possible Types + +| RoutableInterface Types | +|----------------| +| [`CmsPage`](#cmspage) | +| [`CategoryTree`](#categorytree) | +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`RoutableUrl`](#routableurl) | #### Example ```json { - "comment": "xyz789", - "max_order_commitment": 123, - "min_order_commitment": 123, - "name": "xyz789", - "reference_document_links": [ - NegotiableQuoteTemplateReferenceDocumentLinkInput - ], - "template_id": 4 + "redirect_code": 987, + "relative_url": "xyz789", + "type": "CMS_PAGE" } ``` -### SubscribeEmailToNewsletterOutput +### RoutableUrl -Contains the result of the `subscribeEmailToNewsletter` operation. +Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity. #### Fields | Field Name | Description | |------------|-------------| -| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json -{"status": "NOT_ACTIVE"} +{ + "redirect_code": 987, + "relative_url": "abc123", + "type": "CMS_PAGE" +} ``` -### SubscriptionStatusesEnum +### SDKParams -Indicates the status of the request. +Defines the name and value of a SDK parameter -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `NOT_ACTIVE` | | -| `SUBSCRIBED` | | -| `UNSUBSCRIBED` | | -| `UNCONFIRMED` | | +| `name` - [`String`](#string) | The name of the SDK parameter | +| `value` - [`String`](#string) | The value of the SDK parameter | #### Example ```json -""NOT_ACTIVE"" +{ + "name": "xyz789", + "value": "xyz789" +} ``` -### SwatchData +### SalesCommentItem -Describes the swatch type and a value. +Contains details about a comment. #### Fields | Field Name | Description | |------------|-------------| -| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | -| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | +| `message` - [`String!`](#string) | The text of the message. | +| `timestamp` - [`String!`](#string) | The timestamp of the comment. | #### Example ```json { - "type": "xyz789", - "value": "abc123" + "message": "abc123", + "timestamp": "abc123" } ``` -### SwatchDataInterface +### ScopeTypeEnum -#### Fields +This enumeration defines the scope type for customer orders. -| Field Name | Description | +#### Values + +| Enum Value | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `GLOBAL` | | +| `WEBSITE` | | +| `STORE` | | -#### Possible Types +#### Example -| SwatchDataInterface Types | -|----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | +```json +""GLOBAL"" +``` + + + +### SearchResultPageInfo + +Provides navigation for the query response. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `current_page` - [`Int`](#int) | The specific page to return. | +| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](#int) | The total number of pages in the response. | #### Example ```json -{"value": "xyz789"} +{"current_page": 987, "page_size": 123, "total_pages": 987} ``` -### SwatchInputTypeEnum +### SearchSuggestion -Swatch attribute metadata input types. +A string that contains search suggestion -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `DROPDOWN` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `UNDEFINED` | | -| `VISUAL` | | -| `WEIGHT` | | +| `search` - [`String!`](#string) | The search suggestion of existing product. | #### Example ```json -""BOOLEAN"" +{"search": "xyz789"} ``` -### SwatchLayerFilterItem +### SelectedBundleOption + +Contains details about a selected bundle option. #### Fields | Field Name | Description | |------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | +| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `label` - [`String!`](#string) | The display name of the selected bundle product option. | +| `type` - [`String!`](#string) | The type of selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | +| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | #### Example ```json { - "items_count": 987, + "id": 987, "label": "abc123", - "swatch_data": SwatchData, - "value_string": "abc123" + "type": "xyz789", + "uid": 4, + "values": [SelectedBundleOptionValue] } ``` -### SwatchLayerFilterItemInterface +### SelectedBundleOptionValue + +Contains details about a value for a selected bundle option. #### Fields | Field Name | Description | |------------|-------------| -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | +| `id` - [`Int!`](#int) | Use `uid` instead | +| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | +| `original_price` - [`Money!`](#money) | The original price of the value for the selected bundle product option. | +| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | +| `priceV2` - [`Money!`](#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | -#### Possible Types +#### Example -| SwatchLayerFilterItemInterface Types | -|----------------| -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | +```json +{ + "id": 987, + "label": "abc123", + "original_price": Money, + "price": 987.65, + "priceV2": Money, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### SelectedConfigurableOption + +Contains details about a selected configurable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `option_label` - [`String!`](#string) | The display text for the option. | +| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | #### Example ```json -{"swatch_data": SwatchData} +{ + "configurable_product_option_uid": 4, + "configurable_product_option_value_uid": 4, + "id": 123, + "option_label": "abc123", + "value_id": 987, + "value_label": "abc123" +} ``` -### SyncPaymentOrderInput +### SelectedCustomAttributeInput -Synchronizes the payment order details +Contains details about an attribute the buyer selected. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | +| `value` - [`String!`](#string) | The unique ID for a selected custom attribute value. | #### Example ```json { - "cartId": "xyz789", - "id": "abc123" + "attribute_code": "xyz789", + "value": "xyz789" } ``` -### TaxItem +### SelectedCustomizableOption -Contains tax item details. +Identifies a customized product that has been placed in a cart. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | -| `title` - [`String!`](#string) | A title that describes the tax. | +| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | +| `label` - [`String!`](#string) | The display name of the selected customizable option. | +| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | +| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | +| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | #### Example ```json { - "amount": Money, - "rate": 987.65, - "title": "xyz789" + "customizable_option_uid": "4", + "id": 987, + "is_required": false, + "label": "xyz789", + "sort_order": 123, + "type": "abc123", + "values": [SelectedCustomizableOptionValue] } ``` -### TaxWrappingEnum +### SelectedCustomizableOptionValue -#### Values +Identifies the value of the selected customized option. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `DISPLAY_EXCLUDING_TAX` | | -| `DISPLAY_INCLUDING_TAX` | | -| `DISPLAY_TYPE_BOTH` | | +| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `label` - [`String!`](#string) | The display name of the selected value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `value` - [`String!`](#string) | The text identifying the selected value. | #### Example ```json -""DISPLAY_EXCLUDING_TAX"" +{ + "customizable_option_value_uid": 4, + "id": 123, + "label": "xyz789", + "price": CartItemSelectedOptionValuePrice, + "value": "abc123" +} ``` -### TextSwatchData +### SelectedPaymentMethod + +Describes the payment method the shopper selected. #### Fields | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `code` - [`String!`](#string) | The payment method code. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "xyz789", + "purchase_order_number": "xyz789", + "title": "xyz789" +} +``` + + + +### SelectedShippingMethod + +Contains details about the selected shipping method and carrier. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | +| `method_title` - [`String!`](#string) | The label for the method code. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | #### Example ```json -{"value": "xyz789"} +{ + "amount": Money, + "base_amount": Money, + "carrier_code": "xyz789", + "carrier_title": "abc123", + "method_code": "xyz789", + "method_title": "abc123", + "price_excl_tax": Money, + "price_incl_tax": Money +} ``` -### ThreeDSMode +### SendEmailToFriendInput -3D Secure mode. +Defines the referenced product and the email sender and recipients. -#### Values +#### Input Fields -| Enum Value | Description | +| Input Field | Description | +|-------------|-------------| +| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "product_id": 987, + "recipients": [SendEmailToFriendRecipientInput], + "sender": SendEmailToFriendSenderInput +} +``` + + + +### SendEmailToFriendOutput + +Contains information about the sender and recipients. + +#### Fields + +| Field Name | Description | |------------|-------------| -| `OFF` | | -| `SCA_WHEN_REQUIRED` | | -| `SCA_ALWAYS` | | +| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | #### Example ```json -""OFF"" +{ + "recipients": [SendEmailToFriendRecipient], + "sender": SendEmailToFriendSender +} ``` -### TierPrice +### SendEmailToFriendRecipient -Defines a price based on the quantity purchased. +An output object that contains information about the recipient. #### Fields | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](#money) | The price of the product at this tier. | -| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | #### Example ```json { - "discount": ProductDiscount, - "final_price": Money, - "quantity": 987.65 + "email": "xyz789", + "name": "abc123" } ``` -### UpdateCartItemsInput +### SendEmailToFriendRecipientInput -Modifies the specified items in the cart. +Contains details about a recipient. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [CartItemUpdateInput] + "email": "xyz789", + "name": "xyz789" } ``` -### UpdateCartItemsOutput +### SendEmailToFriendSender -Contains details about the cart after updating items. +An output object that contains information about the sender. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "abc123", + "message": "abc123", + "name": "xyz789" +} +``` + + + +### SendEmailToFriendSenderInput + +Contains details about the sender. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | #### Example ```json { - "cart": Cart, - "errors": [CartUserInputError] + "email": "xyz789", + "message": "abc123", + "name": "xyz789" } ``` -### UpdateCompanyOutput +### SendFriendConfiguration -Contains the response to the request to update the company. +Contains details about the configuration of the Email to a Friend feature. #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | #### Example ```json -{"company": Company} +{"enabled_for_customers": true, "enabled_for_guests": false} ``` -### UpdateCompanyRoleOutput +### SendNegotiableQuoteForReviewInput -Contains the response to the request to update the company role. +Specifies which negotiable quote to send for review. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | +| Input Field | Description | +|-------------|-------------| +| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"role": CompanyRole} +{ + "comment": NegotiableQuoteCommentInput, + "quote_uid": "4" +} ``` -### UpdateCompanyStructureOutput +### SendNegotiableQuoteForReviewOutput -Contains the response to the request to update the company structure. +Contains the negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | #### Example ```json -{"company": Company} +{"quote": NegotiableQuote} ``` -### UpdateCompanyTeamOutput +### SetBillingAddressOnCartInput -Contains the response to the request to update a company team. +Sets the billing address. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -{"team": CompanyTeam} +{ + "billing_address": BillingAddressInput, + "cart_id": "abc123" +} ``` -### UpdateCompanyUserOutput +### SetBillingAddressOnCartOutput -Contains the response to the request to update the company user. +Contains details about the cart after setting the billing address. #### Fields | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | +| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | #### Example ```json -{"user": Customer} +{"cart": Cart} ``` -### UpdateGiftRegistryInput +### SetGiftOptionsOnCartInput -Defines updates to a `GiftRegistry` object. +Defines the gift options applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](#string) | The updated name of the event. | -| `message` - [`String`](#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "abc123", - "message": "abc123", - "privacy_settings": "PRIVATE", - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" + "cart_id": "abc123", + "gift_message": GiftMessageInput, + "gift_receipt_included": true, + "gift_wrapping_id": 4, + "printed_card_included": true } ``` -### UpdateGiftRegistryItemInput +### SetGiftOptionsOnCartOutput + +Contains the cart after gift options have been applied. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The modified cart object. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGuestEmailOnCartInput -Defines updates to an item in a gift registry. +Defines the guest email and cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](#string) | The updated description of the item. | -| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `email` - [`String!`](#string) | The email address of the guest. | #### Example ```json { - "gift_registry_item_uid": "4", - "note": "xyz789", - "quantity": 987.65 + "cart_id": "xyz789", + "email": "abc123" } ``` -### UpdateGiftRegistryItemsOutput +### SetGuestEmailOnCartOutput -Contains the results of a request to update gift registry items. +Contains details about the cart after setting the email of a guest. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | +| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | #### Example ```json -{"gift_registry": GiftRegistry} +{"cart": Cart} ``` -### UpdateGiftRegistryOutput +### SetLineItemNoteOutput -Contains the results of a request to update a gift registry. +Contains the updated negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | #### Example ```json -{"gift_registry": GiftRegistry} +{"quote": NegotiableQuote} ``` -### UpdateGiftRegistryRegistrantInput +### SetNegotiableQuoteBillingAddressInput -Defines updates to an existing registrant. +Sets the billing address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | -| `firstname` - [`String`](#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](#string) | The updated last name of the registrant. | +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "abc123", - "firstname": "xyz789", - "gift_registry_registrant_uid": "4", - "lastname": "xyz789" + "billing_address": NegotiableQuoteBillingAddressInput, + "quote_uid": "4" } ``` -### UpdateGiftRegistryRegistrantsOutput +### SetNegotiableQuoteBillingAddressOutput -Contains the results a request to update registrants. +Contains the negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | #### Example ```json -{"gift_registry": GiftRegistry} +{"quote": NegotiableQuote} ``` -### UpdateNegotiableQuoteItemsQuantityOutput +### SetNegotiableQuotePaymentMethodInput -Contains the updated negotiable quote. +Defines the payment method of the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "payment_method": NegotiableQuotePaymentMethodInput, + "quote_uid": "4" +} +``` + + + +### SetNegotiableQuotePaymentMethodOutput + +Contains details about the negotiable quote after setting the payment method. #### Fields @@ -1811,599 +2377,625 @@ Contains the updated negotiable quote. -### UpdateNegotiableQuoteQuantitiesInput +### SetNegotiableQuoteShippingAddressInput -Specifies the items to update. +Defines the shipping address to assign to the negotiable quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | #### Example ```json { - "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": "4" + "customer_address_id": 4, + "quote_uid": "4", + "shipping_addresses": [ + NegotiableQuoteShippingAddressInput + ] } ``` -### UpdateNegotiableQuoteTemplateItemsQuantityOutput +### SetNegotiableQuoteShippingAddressOutput -Contains the updated negotiable quote template. +Contains the negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | #### Example ```json -{"quote_template": NegotiableQuoteTemplate} +{"quote": NegotiableQuote} ``` -### UpdateNegotiableQuoteTemplateQuantitiesInput +### SetNegotiableQuoteShippingMethodsInput -Specifies the items to update. +Defines the shipping method to apply to the negotiable quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | #### Example ```json { - "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": "4" + "quote_uid": 4, + "shipping_methods": [ShippingMethodInput] } ``` -### UpdateProductsInWishlistOutput +### SetNegotiableQuoteShippingMethodsOutput -Contains the customer's wish list and any errors encountered. +Contains the negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | #### Example ```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} +{"quote": NegotiableQuote} ``` -### UpdatePurchaseOrderApprovalRuleInput +### SetNegotiableQuoteTemplateShippingAddressInput -Defines the changes to be made to an approval rule. +Defines the shipping address to assign to the negotiable quote template. #### Input Fields | Input Field | Description | |-------------|-------------| -| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](#string) | The updated approval rule description. | -| `name` - [`String`](#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "applies_to": ["4"], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "abc123", - "status": "ENABLED", - "uid": "4" + "shipping_address": NegotiableQuoteTemplateShippingAddressInput, + "template_id": 4 } ``` -### UpdateRequisitionListInput +### SetPaymentMethodAndPlaceOrderInput -An input object that defines which requistion list characteristics to update. +Applies a payment method to the quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "description": "xyz789", - "name": "xyz789" + "cart_id": "abc123", + "payment_method": PaymentMethodInput } ``` -### UpdateRequisitionListItemsInput +### SetPaymentMethodOnCartInput -Defines which items in a requisition list to update. +Applies a payment method to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | #### Example ```json { - "entered_options": [EnteredOptionInput], - "item_id": "4", - "quantity": 987.65, - "selected_options": ["abc123"] + "cart_id": "xyz789", + "payment_method": PaymentMethodInput } ``` -### UpdateRequisitionListItemsOutput - -Output of the request to update items in the specified requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateRequisitionListOutput +### SetPaymentMethodOnCartOutput -Output of the request to rename the requisition list. +Contains details about the cart after setting the payment method. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | +| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | #### Example ```json -{"requisition_list": RequisitionList} +{"cart": Cart} ``` -### UpdateWishlistOutput +### SetShippingAddressesOnCartInput -Contains the name and visibility of an updated wish list. +Specifies an array of addresses to use for shipping. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | #### Example ```json { - "name": "xyz789", - "uid": 4, - "visibility": "PUBLIC" + "cart_id": "xyz789", + "shipping_addresses": [ShippingAddressInput] } ``` -### UrlRewrite +### SetShippingAddressesOnCartOutput -Contains URL rewrite details. +Contains details about the cart after setting the shipping addresses. #### Fields | Field Name | Description | |------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | #### Example ```json -{ - "parameters": [HttpQueryParameter], - "url": "abc123" -} +{"cart": Cart} ``` -### UrlRewriteEntityTypeEnum +### SetShippingMethodsOnCartInput -This enumeration defines the entity type. +Applies one or shipping methods to the cart. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `CMS_PAGE` | | -| `PRODUCT` | | -| `CATEGORY` | | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | #### Example ```json -""CMS_PAGE"" +{ + "cart_id": "xyz789", + "shipping_methods": [ShippingMethodInput] +} ``` -### UseInLayeredNavigationOptions +### SetShippingMethodsOnCartOutput -Defines whether the attribute is filterable in layered navigation. +Contains details about the cart after setting the shipping methods. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `NO` | | -| `FILTERABLE_WITH_RESULTS` | | -| `FILTERABLE_NO_RESULT` | | +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | #### Example ```json -""NO"" +{"cart": Cart} ``` -### UserCompaniesInput +### ShareGiftRegistryInviteeInput -Defines the input for returning matching companies the customer is assigned to. +Defines a gift registry invitee. #### Input Fields | Input Field | Description | |-------------|-------------| -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](#companiessortinput) | Defines the sorting of the results. | +| `email` - [`String!`](#string) | The email address of the gift registry invitee. | +| `name` - [`String!`](#string) | The name of the gift registry invitee. | #### Example ```json { - "currentPage": 987, - "pageSize": 987, - "sort": [CompaniesSortInput] + "email": "xyz789", + "name": "abc123" } ``` -### UserCompaniesOutput +### ShareGiftRegistryOutput -An object that contains a list of companies customer is assigned to. +Contains the results of a request to share a gift registry. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | +| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | #### Example ```json -{ - "items": [CompanyBasicInfo], - "page_info": SearchResultPageInfo -} +{"is_shared": false} ``` -### ValidatePurchaseOrderError +### ShareGiftRegistrySenderInput -Contains details about a failed validation attempt. +Defines the sender of an invitation to view a gift registry. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | +| Input Field | Description | +|-------------|-------------| +| `message` - [`String!`](#string) | A brief message from the sender. | +| `name` - [`String!`](#string) | The sender of the gift registry invitation. | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{ + "message": "xyz789", + "name": "abc123" +} ``` -### ValidatePurchaseOrderErrorType +### ShipBundleItemsEnum + +Defines whether bundle items must be shipped together. #### Values | Enum Value | Description | |------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | +| `TOGETHER` | | +| `SEPARATELY` | | #### Example ```json -""NOT_FOUND"" +""TOGETHER"" ``` -### ValidatePurchaseOrdersInput - -Defines the purchase orders to be validated. +### ShipmentItem -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | #### Example ```json -{"purchase_order_uids": [4]} +{ + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 123.45 +} ``` -### ValidatePurchaseOrdersOutput +### ShipmentItemInterface -Contains the results of validation attempts. +Order shipment item details. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Possible Types + +| ShipmentItemInterface Types | +|----------------| +| [`BundleShipmentItem`](#bundleshipmentitem) | +| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`ShipmentItem`](#shipmentitem) | #### Example ```json { - "errors": [ValidatePurchaseOrderError], - "purchase_orders": [PurchaseOrder] + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 987.65 } ``` -### ValidationRule +### ShipmentTracking -Defines a customer attribute validation rule. +Contains order shipment tracking details. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | +| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | +| `number` - [`String`](#string) | The tracking number of the order shipment. | +| `title` - [`String!`](#string) | The shipment tracking title. | #### Example ```json { - "name": "DATE_RANGE_MAX", - "value": "xyz789" + "carrier": "abc123", + "number": "abc123", + "title": "xyz789" } ``` -### ValidationRuleEnum +### ShippingAddressInput -List of validation rule names applied to a customer attribute. +Defines a single shipping address. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `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` | | +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | #### Example ```json -""DATE_RANGE_MAX"" +{ + "address": CartAddressInput, + "customer_address_id": 123, + "customer_notes": "abc123", + "pickup_location_code": "xyz789" +} ``` -### VaultConfigOutput +### ShippingCartAddress -Retrieves the vault configuration +Contains shipping addresses and methods. #### Fields | Field Name | Description | |------------|-------------| -| `credit_card` - [`VaultCreditCardConfig`](#vaultcreditcardconfig) | Credit card vault method configuration | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. | +| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](#boolean) | Indicates whether the shipping address is same as billing address. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`String!`](#string) | The unique id of the customer address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example ```json -{"credit_card": VaultCreditCardConfig} +{ + "available_shipping_methods": [AvailableShippingMethod], + "cart_items": [CartItemQuantity], + "cart_items_v2": [CartItemInterface], + "city": "abc123", + "company": "abc123", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_notes": "abc123", + "fax": "abc123", + "firstname": "abc123", + "id": 987, + "items_weight": 123.45, + "lastname": "abc123", + "middlename": "xyz789", + "pickup_location_code": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CartAddressRegion, + "same_as_billing": true, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", + "uid": "abc123", + "vat_id": "xyz789" +} ``` -### VaultCreditCardConfig +### ShippingDiscount + +Defines an individual shipping discount. This discount can be applied to shipping. #### Fields | Field Name | Description | |------------|-------------| -| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `amount` - [`Money!`](#money) | The amount of the discount. | #### Example ```json -{ - "is_vault_enabled": true, - "sdk_params": [SDKParams], - "three_ds_mode": "OFF" -} +{"amount": Money} ``` -### VaultMethodInput +### ShippingHandling -Vault payment inputs +Contains details about shipping and handling costs. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | -| `public_hash` - [`String`](#string) | The public hash of the token. | +| Field Name | Description | +|------------|-------------| +| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | +| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](#money) | The total amount for shipping. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123", - "public_hash": "abc123" -} -``` - - - -### VaultSetupTokenInput - -The payment source information - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | - -#### Example - -```json -{"payment_source": PaymentSourceInput} + "amount_excluding_tax": Money, + "amount_including_tax": Money, + "discounts": [ShippingDiscount], + "taxes": [TaxItem], + "total_amount": Money +} ``` -### VaultTokenInput +### ShippingMethodInput -Contains required input for payment methods with Vault support. +Defines the shipping carrier and method. #### Input Fields | Input Field | Description | |-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | +| `method_code` - [`String!`](#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 ```json -{"public_hash": "abc123"} +{ + "carrier_code": "xyz789", + "method_code": "xyz789" +} ``` -### VirtualCartItem +### SimpleCartItem -An implementation for virtual product cart items. +An implementation for simple product cart items. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | | `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | | `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | | `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | | `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { + "available_gift_wrapping": [GiftWrapping], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "id": "xyz789", - "is_available": false, + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "abc123", + "is_available": true, "max_qty": 987.65, "min_qty": 123.45, "not_available_message": "xyz789", @@ -2411,68 +3003,68 @@ An implementation for virtual product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` -### VirtualProduct +### SimpleProduct -Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. +Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. #### Fields | Field Name | Description | |------------|-------------| -| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#string) | The relative canonical URL. This value is returned only if the system setting 'Use Canonical Link Meta Tag For Products' is enabled. | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | | `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | | `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | | `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | | `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | | `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | | `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | | `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | | `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | | `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | | `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | | `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | | `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | | `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | | `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | | `new_to_date` - [`String`](#string) | The end date for new product listings. | | `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | | `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | | `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | | `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `quantity` - [`Float`](#float) | Amount of available stock | | `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | | `redirect_code` - [`Int!`](#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. | @@ -2481,111 +3073,112 @@ Defines a virtual product, which is a non-tangible product that does not require | `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | | `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | | `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | -| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | | `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | | `special_price` - [`Float`](#float) | The discounted price of the product. | | `special_to_date` - [`String`](#string) | The end date for a product with a special price. | | `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | | `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | | `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | | `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | | `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | | `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | | `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | | `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | | `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | | `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "activity": "xyz789", - "attribute_set_id": 123, + "activity": "abc123", + "attribute_set_id": 987, "canonical_url": "xyz789", "categories": [CategoryInterface], - "category_gear": "abc123", - "climate": "xyz789", - "collar": "abc123", - "color": 987, + "category_gear": "xyz789", + "climate": "abc123", + "collar": "xyz789", + "color": 123, "country_of_manufacture": "abc123", "created_at": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "eco_collection": 123, - "erin_recommends": 987, + "erin_recommends": 123, "features_bags": "xyz789", - "format": 123, + "format": 987, "gender": "xyz789", - "gift_message_available": false, - "gift_wrapping_available": true, + "gift_message_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "id": 987, "image": ProductImage, - "is_returnable": "xyz789", + "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": "abc123", - "new": 987, - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", + "new": 123, + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "xyz789", "pattern": "xyz789", - "performance_fabric": 987, + "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": 987, + "purpose": 123, + "quantity": 987.65, + "rating_summary": 123.45, + "redirect_code": 123, "related_products": [ProductInterface], "relative_url": "abc123", "review_count": 987, "reviews": ProductReviews, "rules": [CatalogRule], - "sale": 123, + "sale": 987, "short_description": ComplexTextValue, - "size": 987, - "sku": "abc123", + "size": 123, + "sku": "xyz789", "sleeve": "abc123", "small_image": ProductImage, - "special_from_date": "xyz789", + "special_from_date": "abc123", "special_price": 987.65, "special_to_date": "abc123", - "staged": true, + "staged": false, "stock_status": "IN_STOCK", - "strap_bags": "xyz789", + "strap_bags": "abc123", "style_bags": "xyz789", - "style_bottom": "abc123", - "style_general": "xyz789", - "swatch_image": "abc123", + "style_bottom": "xyz789", + "style_general": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "tier_price": 123.45, "tier_prices": [ProductTierPrices], @@ -2594,17 +3187,18 @@ Defines a virtual product, which is a non-tangible product that does not require "uid": "4", "updated_at": "abc123", "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "url_path": "abc123", "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website] + "url_suffix": "abc123", + "websites": [Website], + "weight": 123.45 } ``` -### VirtualProductCartItemInput +### SimpleProductCartItemInput Defines a single product to add to the cart. @@ -2613,7 +3207,7 @@ Defines a single product to add to the cart. | Input Field | Description | |-------------|-------------| | `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | #### Example @@ -2626,9 +3220,9 @@ Defines a single product to add to the cart. -### VirtualRequisitionListItem +### SimpleRequisitionListItem -Contains details about virtual products added to a requisition list. +Contains details about simple products added to a requisition list. #### Fields @@ -2652,9 +3246,9 @@ Contains details about virtual products added to a requisition list. -### VirtualWishlistItem +### SimpleWishlistItem -Contains a virtual product wish list item. +Contains a simple product wish list item. #### Fields @@ -2663,7 +3257,7 @@ Contains a virtual product wish list item. | `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | | `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | | `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | | `quantity` - [`Float!`](#float) | The quantity of this wish list item. | @@ -2673,7 +3267,7 @@ Contains a virtual product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "product": ProductInterface, "quantity": 987.65 @@ -2682,406 +3276,941 @@ Contains a virtual product wish list item. -### Website +### SmartButtonMethodInput + +Smart button payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "abc123", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789" +} +``` + + + +### SmartButtonsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": ButtonStyles, + "code": "abc123", + "display_message": false, + "display_venmo": true, + "is_visible": true, + "message_styles": MessageStyles, + "payment_intent": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "xyz789" +} +``` + + + +### SortEnum + +Indicates whether to return results in ascending or descending order. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ASC` | | +| `DESC` | | + +#### Example + +```json +""ASC"" +``` + + + +### SortField + +Defines a possible sort field. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label of the sort field. | +| `value` - [`String`](#string) | The attribute code of the sort field. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### SortFields + +Contains a default value for sort fields and all available sort fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `default` - [`String`](#string) | The default sort field value. | +| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | + +#### Example + +```json +{ + "default": "abc123", + "options": [SortField] +} +``` + + + +### SortQuoteItemsEnum + +Specifies the field to use for sorting quote items + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ITEM_ID"" +``` + + + +### StoreConfig -Deprecated. It should not be used on the storefront. Contains information about a website. +Contains information about a store's configuration. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | -| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | +| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `` tag. | +| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | +| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | +| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | +| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | +| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `base_currency_code` - [`String`](#string) | The base currency code. | +| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | +| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | +| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | +| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | +| `braintree_3dsecure_allowspecific` - [`Boolean`](#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](#boolean) | Braintree 3D Secure, always request 3D Secure flag. | +| `braintree_3dsecure_specificcountry` - [`String`](#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`](#string) | Braintree 3D Secure, threshold above which 3D Secure should be requested. | +| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](#boolean) | Braintree ACH vault status. | +| `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | +| `braintree_applepay_vault_active` - [`Boolean`](#boolean) | Braintree Apple Pay vault status. | +| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | +| `braintree_cc_vault_cvv` - [`Boolean`](#boolean) | Braintree cc vault CVV re-verification enabled status. | +| `braintree_environment` - [`String`](#string) | Braintree environment. | +| `braintree_googlepay_btn_color` - [`String`](#string) | Braintree Google Pay button color. | +| `braintree_googlepay_cctypes` - [`String`](#string) | Braintree Google Pay Card types supported. | +| `braintree_googlepay_merchant_id` - [`String`](#string) | Braintree Google Pay merchant ID. | +| `braintree_googlepay_vault_active` - [`Boolean`](#boolean) | Braintree Google Pay vault status. | +| `braintree_local_payment_allowed_methods` - [`String`](#string) | Braintree Local Payment Methods allowed payment methods. | +| `braintree_local_payment_fallback_button_text` - [`String`](#string) | Braintree Local Payment Methods fallback button text. | +| `braintree_local_payment_redirect_on_fail` - [`String`](#string) | Braintree Local Payment Methods redirect URL on failed payment. | +| `braintree_merchant_account_id` - [`String`](#string) | Braintree Merchant Account ID. | +| `braintree_paypal_button_location_cart_type_credit_color` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_credit_label` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style layout. | +| `braintree_paypal_button_location_cart_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo. | +| `braintree_paypal_button_location_cart_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo position. | +| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | +| `braintree_paypal_button_location_cart_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | +| `braintree_paypal_button_location_cart_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_paypal_color` - [`String`](#string) | Braintree PayPal mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_paypal_label` - [`String`](#string) | Braintree PayPal mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_paypal_shape` - [`String`](#string) | Braintree PayPal mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal mini-cart & cart button show. | +| `braintree_paypal_button_location_checkout_type_credit_color` - [`String`](#string) | Braintree PayPal Credit checkout button style color. | +| `braintree_paypal_button_location_checkout_type_credit_label` - [`String`](#string) | Braintree PayPal Credit checkout button style label. | +| `braintree_paypal_button_location_checkout_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit checkout button show status. | +| `braintree_paypal_button_location_checkout_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style layout. | +| `braintree_paypal_button_location_checkout_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo. | +| `braintree_paypal_button_location_checkout_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo position. | +| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging checkout show status. | +| `braintree_paypal_button_location_checkout_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | +| `braintree_paypal_button_location_checkout_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later checkout button style color. | +| `braintree_paypal_button_location_checkout_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later checkout button style label. | +| `braintree_paypal_button_location_checkout_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later checkout button show status. | +| `braintree_paypal_button_location_checkout_type_paypal_color` - [`String`](#string) | Braintree PayPal checkout button style color. | +| `braintree_paypal_button_location_checkout_type_paypal_label` - [`String`](#string) | Braintree PayPal checkout button style label. | +| `braintree_paypal_button_location_checkout_type_paypal_shape` - [`String`](#string) | Braintree PayPal checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal checkout button show. | +| `braintree_paypal_button_location_productpage_type_credit_color` - [`String`](#string) | Braintree PayPal Credit PDP button style color. | +| `braintree_paypal_button_location_productpage_type_credit_label` - [`String`](#string) | Braintree PayPal Credit PDP button style label. | +| `braintree_paypal_button_location_productpage_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit PDP button show status. | +| `braintree_paypal_button_location_productpage_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style layout. | +| `braintree_paypal_button_location_productpage_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo. | +| `braintree_paypal_button_location_productpage_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo position. | +| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging PDP show status. | +| `braintree_paypal_button_location_productpage_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style text color. | +| `braintree_paypal_button_location_productpage_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later PDP button style color. | +| `braintree_paypal_button_location_productpage_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later PDP button style label. | +| `braintree_paypal_button_location_productpage_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later PDP button show status. | +| `braintree_paypal_button_location_productpage_type_paypal_color` - [`String`](#string) | Braintree PayPal PDP button style color. | +| `braintree_paypal_button_location_productpage_type_paypal_label` - [`String`](#string) | Braintree PayPal PDP button style label. | +| `braintree_paypal_button_location_productpage_type_paypal_shape` - [`String`](#string) | Braintree PayPal PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal PDP button show. | +| `braintree_paypal_credit_uk_merchant_name` - [`String`](#string) | Braintree PayPal Credit Merchant Name on the FCA Register. | +| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](#boolean) | Should display Braintree PayPal in mini-cart & cart? | +| `braintree_paypal_merchant_country` - [`String`](#string) | Braintree PayPal merchant's country. | +| `braintree_paypal_merchant_name_override` - [`String`](#string) | Braintree PayPal override for Merchant Name. | +| `braintree_paypal_require_billing_address` - [`Boolean`](#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](#int) | checkout/cart/delete_quote_after: quote lifetime in days. | +| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | +| `cart_printed_card` - [`String`](#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`](#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`](#string) | The default sort order of the search results list. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | +| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | +| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | +| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | +| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | +| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | +| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | +| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | +| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | +| `configurable_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | +| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | +| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | +| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | +| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | +| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | +| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | +| `default_description` - [`String`](#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`](#string) | The default display currency code. | +| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | +| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | +| `demonotice` - [`Int`](#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!`](#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | +| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `front` - [`String`](#string) | The landing page that is associated with the base URL. | +| `graphql_share_all_customer_groups` - [`Boolean!`](#boolean) | Configuration data from customer/account_information/graphql_share_all_customer_groups | +| `graphql_share_customer_group` - [`Boolean!`](#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | +| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | +| `grouped_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `` tag. | +| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | +| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | +| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_checkout_agreements_enabled` - [`Boolean!`](#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | +| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | +| `list_mode` - [`String`](#string) | The format of the search results list. | +| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | +| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | +| `locale` - [`String`](#string) | The store locale. | +| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | +| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | +| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | +| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | +| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | +| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | +| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | +| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | +| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | +| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | +| `max_items_in_order_summary` - [`Int`](#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | +| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | +| `minicart_display` - [`Boolean`](#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](#int) | checkout/sidebar/count: maximum number of items to show in minicart. | +| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | +| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | +| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | +| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | +| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/zero_tax | +| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | +| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. *(Deprecated: Use printed_card_priceV2 instead)* | +| `printed_card_priceV2` - [`Money`](#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | +| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | +| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | +| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | +| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | +| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | +| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | +| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | +| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | +| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | +| `share_all_catalog_rules` - [`Boolean!`](#boolean) | Configuration data from catalog/rule/share_all_catalog_rules | +| `share_all_sales_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_all_sales_rule | +| `share_applied_catalog_rules` - [`Boolean!`](#boolean) | Configuration data from catalog/rule/share_applied_catalog_rules | +| `share_applied_sales_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_applied_sales_rule | +| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `store_group_name` - [`String`](#string) | The label assigned to the store group. | +| `store_name` - [`String`](#string) | The label assigned to the store view. | +| `store_sort_order` - [`Int`](#int) | The store view sort order. | +| `timezone` - [`String`](#string) | The time zone of the store. | +| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | +| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | +| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | +| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](#id) | The unique ID for the website. | +| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `website_name` - [`String`](#string) | The label assigned to the website. | +| `weight_unit` - [`String`](#string) | The unit of weight. | +| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | +| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | +| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | #### Example ```json { + "absolute_footer": "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_items": "abc123", + "allow_order": "xyz789", + "allow_printed_card": "xyz789", + "autocomplete_on_storefront": false, + "base_currency_code": "abc123", + "base_link_url": "abc123", + "base_media_url": "abc123", + "base_static_url": "abc123", + "base_url": "xyz789", + "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": "xyz789", + "braintree_applepay_vault_active": false, + "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_cvv": false, + "braintree_environment": "abc123", + "braintree_googlepay_btn_color": "abc123", + "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_merchant_id": "abc123", + "braintree_googlepay_vault_active": false, + "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": "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_show": false, + "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_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_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": "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": "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": 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": false, + "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": "abc123", + "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": "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_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": "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_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_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": "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": "xyz789", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 987, + "check_money_order_title": "xyz789", + "cms_home_page": "xyz789", + "cms_no_cookies": "xyz789", + "cms_no_route": "xyz789", "code": "xyz789", - "default_group_id": "xyz789", + "configurable_product_image": "ITSELF", + "configurable_thumbnail_source": "xyz789", + "contact_enabled": true, + "copyright": "abc123", + "countries_with_required_region": "abc123", + "create_account_confirmation": false, + "customer_access_token_lifetime": 987.65, + "default_country": "xyz789", + "default_description": "abc123", + "default_display_currency_code": "abc123", + "default_keywords": "abc123", + "default_title": "abc123", + "demonotice": 987, + "display_product_prices_in_catalog": 123, + "display_shipping_prices": 987, + "display_state_if_optional": false, + "enable_multiple_wishlists": "xyz789", + "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_include_fpt_in_subtotal": false, + "front": "abc123", + "graphql_share_all_customer_groups": true, + "graphql_share_customer_group": true, + "grid_per_page": 987, + "grid_per_page_values": "xyz789", + "grouped_product_image": "ITSELF", + "head_includes": "abc123", + "head_shortcut_icon": "abc123", + "header_logo_src": "abc123", "id": 123, - "is_default": true, - "name": "abc123", - "sort_order": 987 + "is_checkout_agreements_enabled": true, + "is_default_store": true, + "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": "abc123", + "list_mode": "xyz789", + "list_per_page": 987, + "list_per_page_values": "abc123", + "locale": "xyz789", + "logo_alt": "xyz789", + "logo_height": 123, + "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": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", + "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_register": "abc123", + "magento_reward_points_review": "xyz789", + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "abc123", + "minicart_display": true, + "minicart_max_items": 987, + "minimum_password_length": "abc123", + "newsletter_enabled": true, + "no_route": "xyz789", + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": false, + "order_cancellation_reasons": [CancellationReason], + "orders_invoices_credit_memos_display_full_summary": true, + "orders_invoices_credit_memos_display_grandtotal": false, + "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": 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": "abc123", + "quickorder_active": false, + "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": "abc123", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "abc123", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", + "send_friend": SendFriendConfiguration, + "share_all_catalog_rules": true, + "share_all_sales_rule": false, + "share_applied_catalog_rules": false, + "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": 123, + "shopping_cart_display_subtotal": 123, + "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", + "shopping_cart_display_zero_tax": false, + "show_cms_breadcrumbs": 987, + "store_code": 4, + "store_group_code": "4", + "store_group_name": "abc123", + "store_name": "abc123", + "store_sort_order": 987, + "timezone": "xyz789", + "title_prefix": "abc123", + "title_separator": "xyz789", + "title_suffix": "xyz789", + "use_store_in_url": false, + "website_code": "4", + "website_id": 123, + "website_name": "abc123", + "weight_unit": "xyz789", + "welcome": "abc123", + "zero_subtotal_enable_for_specific_countries": false, + "zero_subtotal_enabled": true, + "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": "xyz789" } ``` -### WishListUserInputError +### StorefrontProperties -An error encountered while performing operations with WishList. +Indicates where an attribute can be displayed. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | #### Example ```json { - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "position": 123, + "use_in_layered_navigation": "NO", + "use_in_product_listing": false, + "use_in_search_results_layered_navigation": false, + "visible_on_catalog_pages": false } ``` -### WishListUserInputErrorType - -A list of possible error types. - -#### Values +### String -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `UNDEFINED` | | +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 ```json -""PRODUCT_NOT_FOUND"" +"abc123" ``` -### Wishlist +### SubmitNegotiableQuoteTemplateForReviewInput -Contains a customer wish list. +Specifies the quote template properties to update. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | -| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. | -| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | -| `name` - [`String`](#string) | The name of the wish list. | -| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String`](#string) | A comment for the seller to review. | +| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | +| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "id": 4, - "items": [WishlistItem], - "items_count": 987, - "items_v2": WishlistItems, - "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "abc123", - "visibility": "PUBLIC" + "comment": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 987, + "name": "xyz789", + "reference_document_links": [ + NegotiableQuoteTemplateReferenceDocumentLinkInput + ], + "template_id": "4" } ``` -### WishlistCartUserInputError +### SubscribeEmailToNewsletterOutput -Contains details about errors encountered when a customer added wish list items to the cart. +Contains the result of the `subscribeEmailToNewsletter` operation. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](#string) | A localized error message. | -| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | +| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | #### Example ```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", - "wishlistId": 4, - "wishlistItemId": 4 -} +{"status": "NOT_ACTIVE"} ``` -### WishlistCartUserInputErrorType +### SubscriptionStatusesEnum -A list of possible error types. +Indicates the status of the request. #### Values | Enum Value | Description | |------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | +| `NOT_ACTIVE` | | +| `SUBSCRIBED` | | +| `UNSUBSCRIBED` | | +| `UNCONFIRMED` | | #### Example ```json -""PRODUCT_NOT_FOUND"" +""NOT_ACTIVE"" ``` -### WishlistItem +### SwatchData -Contains details about a wish list item. +Describes the swatch type and a value. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](#string) | The customer's comment about this item. | -| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](#float) | The quantity of this wish list item | - -#### Example - -```json -{ - "added_at": "xyz789", - "description": "abc123", - "id": 987, - "product": ProductInterface, - "qty": 123.45 -} -``` - - - -### WishlistItemCopyInput - -Specifies the IDs of items to copy and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | - -#### Example - -```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} -``` - - - -### WishlistItemInput - -Defines the items to add to a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | +| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | +| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | #### Example ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 987.65, - "selected_options": [4], - "sku": "xyz789" + "type": "xyz789", + "value": "abc123" } ``` -### WishlistItemInterface - -The interface for wish list items. +### SwatchDataInterface #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | #### Possible Types -| WishlistItemInterface Types | +| SwatchDataInterface Types | |----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | -| [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### WishlistItemMoveInput - -Specifies the IDs of the items to move and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | +| [`ImageSwatchData`](#imageswatchdata) | +| [`TextSwatchData`](#textswatchdata) | +| [`ColorSwatchData`](#colorswatchdata) | #### Example ```json -{"quantity": 123.45, "wishlist_item_id": 4} +{"value": "abc123"} ``` -### WishlistItemUpdateInput +### SwatchInputTypeEnum -Defines updates to items in a wish list. +Swatch attribute metadata input types. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `DROPDOWN` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `UNDEFINED` | | +| `VISUAL` | | +| `WEIGHT` | | #### Example ```json -{ - "description": "abc123", - "entered_options": [EnteredOptionInput], - "quantity": 123.45, - "selected_options": [4], - "wishlist_item_id": 4 -} +""BOOLEAN"" ``` -### WishlistItems - -Contains an array of items in a wish list. +### SwatchLayerFilterItem #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example ```json { - "items": [WishlistItemInterface], - "page_info": SearchResultPageInfo + "items_count": 987, + "label": "abc123", + "swatch_data": SwatchData, + "value_string": "xyz789" } ``` -### WishlistOutput - -Deprecated: Use the `Wishlist` type instead. +### SwatchLayerFilterItemInterface #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | -| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | - -#### Example - -```json -{ - "items": [WishlistItem], - "items_count": 123, - "name": "abc123", - "sharing_code": "xyz789", - "updated_at": "abc123" -} -``` - - - -### WishlistVisibilityEnum - -Defines the wish list visibility types. +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | -#### Values +#### Possible Types -| Enum Value | Description | -|------------|-------------| -| `PUBLIC` | | -| `PRIVATE` | | +| SwatchLayerFilterItemInterface Types | +|----------------| +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | #### Example ```json -""PUBLIC"" +{"swatch_data": SwatchData} ``` -### createEmptyCartInput +### SyncPaymentOrderInput -Assigns a specific `cart_id` to the empty cart. +Synchronizes the payment order details #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | +| `cartId` - [`String!`](#string) | The customer cart ID | +| `id` - [`String!`](#string) | PayPal order ID | #### Example ```json -{"cart_id": "xyz789"} +{ + "cartId": "xyz789", + "id": "xyz789" +} ``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-t-z.md new file mode 100644 index 000000000..a56614469 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-t-z.md @@ -0,0 +1,1654 @@ +## Types + +### TaxItem + +Contains tax item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | +| `title` - [`String!`](#string) | A title that describes the tax. | + +#### Example + +```json +{ + "amount": Money, + "rate": 123.45, + "title": "xyz789" +} +``` + + + +### TaxWrappingEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `DISPLAY_EXCLUDING_TAX` | | +| `DISPLAY_INCLUDING_TAX` | | +| `DISPLAY_TYPE_BOTH` | | + +#### Example + +```json +""DISPLAY_EXCLUDING_TAX"" +``` + + + +### TextSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### ThreeDSMode + +3D Secure mode. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OFF` | | +| `SCA_WHEN_REQUIRED` | | +| `SCA_ALWAYS` | | + +#### Example + +```json +""OFF"" +``` + + + +### TierPrice + +Defines a price based on the quantity purchased. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](#money) | The price of the product at this tier. | +| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | + +#### Example + +```json +{ + "discount": ProductDiscount, + "final_price": Money, + "quantity": 123.45 +} +``` + + + +### UpdateCartItemsInput + +Modifies the specified items in the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [CartItemUpdateInput] +} +``` + + + +### UpdateCartItemsOutput + +Contains details about the cart after updating items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "errors": [CartUserInputError] +} +``` + + + +### UpdateCompanyOutput + +Contains the response to the request to update the company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyRoleOutput + +Contains the response to the request to update the company role. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | + +#### Example + +```json +{"role": CompanyRole} +``` + + + +### UpdateCompanyStructureOutput + +Contains the response to the request to update the company structure. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyTeamOutput + +Contains the response to the request to update a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | + +#### Example + +```json +{"team": CompanyTeam} +``` + + + +### UpdateCompanyUserOutput + +Contains the response to the request to update the company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user` - [`Customer!`](#customer) | The updated company user instance. | + +#### Example + +```json +{"user": Customer} +``` + + + +### UpdateGiftRegistryInput + +Defines updates to a `GiftRegistry` object. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](#string) | The updated name of the event. | +| `message` - [`String`](#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "abc123", + "message": "abc123", + "privacy_settings": "PRIVATE", + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" +} +``` + + + +### UpdateGiftRegistryItemInput + +Defines updates to an item in a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](#string) | The updated description of the item. | +| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | + +#### Example + +```json +{ + "gift_registry_item_uid": "4", + "note": "xyz789", + "quantity": 123.45 +} +``` + + + +### UpdateGiftRegistryItemsOutput + +Contains the results of a request to update gift registry items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryOutput + +Contains the results of a request to update a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryRegistrantInput + +Defines updates to an existing registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | +| `firstname` - [`String`](#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](#string) | The updated last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "abc123", + "firstname": "abc123", + "gift_registry_registrant_uid": "4", + "lastname": "xyz789" +} +``` + + + +### UpdateGiftRegistryRegistrantsOutput + +Contains the results a request to update registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateNegotiableQuoteItemsQuantityOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### UpdateNegotiableQuoteQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteItemQuantityInput], + "quote_uid": 4 +} +``` + + + +### UpdateNegotiableQuoteTemplateItemsQuantityOutput + +Contains the updated negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | + +#### Example + +```json +{"quote_template": NegotiableQuoteTemplate} +``` + + + +### UpdateNegotiableQuoteTemplateQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteTemplateItemQuantityInput], + "template_id": "4" +} +``` + + + +### UpdateProductsInWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### UpdatePurchaseOrderApprovalRuleInput + +Defines the changes to be made to an approval rule. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](#string) | The updated approval rule description. | +| `name` - [`String`](#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | + +#### Example + +```json +{ + "applies_to": ["4"], + "approvers": [4], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "abc123", + "name": "abc123", + "status": "ENABLED", + "uid": "4" +} +``` + + + +### UpdateRequisitionListInput + +An input object that defines which requistion list characteristics to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | The updated description of the requisition list. | +| `name` - [`String!`](#string) | The new name of the requisition list. | + +#### Example + +```json +{ + "description": "abc123", + "name": "xyz789" +} +``` + + + +### UpdateRequisitionListItemsInput + +Defines which items in a requisition list to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "item_id": 4, + "quantity": 123.45, + "selected_options": ["xyz789"] +} +``` + + + +### UpdateRequisitionListItemsOutput + +Output of the request to update items in the specified requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateRequisitionListOutput + +Output of the request to rename the requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateWishlistOutput + +Contains the name and visibility of an updated wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](#string) | The wish list name. | +| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "name": "abc123", + "uid": 4, + "visibility": "PUBLIC" +} +``` + + + +### UrlRewrite + +Contains URL rewrite details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](#string) | The request URL. | + +#### Example + +```json +{ + "parameters": [HttpQueryParameter], + "url": "abc123" +} +``` + + + +### UrlRewriteEntityTypeEnum + +This enumeration defines the entity type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CMS_PAGE` | | +| `PRODUCT` | | +| `CATEGORY` | | + +#### Example + +```json +""CMS_PAGE"" +``` + + + +### UseInLayeredNavigationOptions + +Defines whether the attribute is filterable in layered navigation. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NO` | | +| `FILTERABLE_WITH_RESULTS` | | +| `FILTERABLE_NO_RESULT` | | + +#### Example + +```json +""NO"" +``` + + + +### UserCompaniesInput + +Defines the input for returning matching companies the customer is assigned to. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](#companiessortinput) | Defines the sorting of the results. | + +#### Example + +```json +{ + "currentPage": 123, + "pageSize": 987, + "sort": [CompaniesSortInput] +} +``` + + + +### UserCompaniesOutput + +An object that contains a list of companies customer is assigned to. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | + +#### Example + +```json +{ + "items": [CompanyBasicInfo], + "page_info": SearchResultPageInfo +} +``` + + + +### ValidatePurchaseOrderError + +Contains details about a failed validation attempt. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | + +#### Example + +```json +{"message": "abc123", "type": "NOT_FOUND"} +``` + + + +### ValidatePurchaseOrderErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | + +#### Example + +```json +""NOT_FOUND"" +``` + + + +### ValidatePurchaseOrdersInput + +Defines the purchase orders to be validated. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | + +#### Example + +```json +{"purchase_order_uids": [4]} +``` + + + +### ValidatePurchaseOrdersOutput + +Contains the results of validation attempts. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | + +#### Example + +```json +{ + "errors": [ValidatePurchaseOrderError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### ValidationRule + +Defines a customer attribute validation rule. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | +| `value` - [`String`](#string) | Validation rule value. | + +#### Example + +```json +{ + "name": "DATE_RANGE_MAX", + "value": "abc123" +} +``` + + + +### ValidationRuleEnum + +List of validation rule names applied to a customer attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""DATE_RANGE_MAX"" +``` + + + +### VaultConfigOutput + +Retrieves the vault configuration + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `credit_card` - [`VaultCreditCardConfig`](#vaultcreditcardconfig) | Credit card vault method configuration | + +#### Example + +```json +{"credit_card": VaultCreditCardConfig} +``` + + + +### VaultCreditCardConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | + +#### Example + +```json +{ + "is_vault_enabled": false, + "sdk_params": [SDKParams], + "three_ds_mode": "OFF" +} +``` + + + +### VaultMethodInput + +Vault payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| `public_hash` - [`String`](#string) | The public hash of the token. | + +#### Example + +```json +{ + "payment_source": "abc123", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789", + "public_hash": "xyz789" +} +``` + + + +### VaultSetupTokenInput + +The payment source information + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | + +#### Example + +```json +{"payment_source": PaymentSourceInput} +``` + + + +### VaultTokenInput + +Contains required input for payment methods with Vault support. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `public_hash` - [`String!`](#string) | The public hash of the payment token. | + +#### Example + +```json +{"public_hash": "abc123"} +``` + + + +### VirtualCartItem + +An implementation for virtual product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "id": "abc123", + "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" +} +``` + + + +### VirtualProduct + +Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activity` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `category_gear` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `climate` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `collar` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `eco_collection` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `erin_recommends` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `features_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `format` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gender` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `material` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `pattern` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `performance_fabric` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `purpose` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `rules` - [`[CatalogRule]`](#catalogrule) | Provides applied catalog rules in the current active cart | +| `sale` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `size` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `sleeve` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `strap_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bags` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_bottom` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `style_general` - [`String`](#string) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "activity": "abc123", + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "category_gear": "abc123", + "climate": "xyz789", + "collar": "abc123", + "color": 987, + "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": false, + "gift_wrapping_price": Money, + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "material": "abc123", + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "xyz789", + "new": 987, + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "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": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "rules": [CatalogRule], + "sale": 123, + "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": false, + "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": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website] +} +``` + + + +### VirtualProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### VirtualRequisitionListItem + +Contains details about virtual products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### VirtualWishlistItem + +Contains a virtual product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### Website + +Deprecated. It should not be used on the storefront. Contains information about a website. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | +| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "code": "abc123", + "default_group_id": "abc123", + "id": 123, + "is_default": false, + "name": "xyz789", + "sort_order": 123 +} +``` + + + +### WishListUserInputError + +An error encountered while performing operations with WishList. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123" +} +``` + + + +### WishListUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### Wishlist + +Contains a customer wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. | +| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | +| `name` - [`String`](#string) | The name of the wish list. | +| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "id": "4", + "items": [WishlistItem], + "items_count": 987, + "items_v2": WishlistItems, + "name": "abc123", + "sharing_code": "abc123", + "updated_at": "abc123", + "visibility": "PUBLIC" +} +``` + + + +### WishlistCartUserInputError + +Contains details about errors encountered when a customer added wish list items to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | +| `message` - [`String!`](#string) | A localized error message. | +| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789", + "wishlistId": "4", + "wishlistItemId": "4" +} +``` + + + +### WishlistCartUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### WishlistItem + +Contains details about a wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](#string) | The customer's comment about this item. | +| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](#float) | The quantity of this wish list item | + +#### Example + +```json +{ + "added_at": "abc123", + "description": "xyz789", + "id": 123, + "product": ProductInterface, + "qty": 987.65 +} +``` + + + +### WishlistItemCopyInput + +Specifies the IDs of items to copy and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | + +#### Example + +```json +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} +``` + + + +### WishlistItemInput + +Defines the items to add to a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 987.65, + "selected_options": ["4"], + "sku": "xyz789" +} +``` + + + +### WishlistItemInterface + +The interface for wish list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Possible Types + +| WishlistItemInterface Types | +|----------------| +| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`VirtualWishlistItem`](#virtualwishlistitem) | +| [`ConfigurableWishlistItem`](#configurablewishlistitem) | +| [`BundleWishlistItem`](#bundlewishlistitem) | +| [`DownloadableWishlistItem`](#downloadablewishlistitem) | +| [`GiftCardWishlistItem`](#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### WishlistItemMoveInput + +Specifies the IDs of the items to move and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | + +#### Example + +```json +{"quantity": 123.45, "wishlist_item_id": 4} +``` + + + +### WishlistItemUpdateInput + +Defines updates to items in a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | + +#### Example + +```json +{ + "description": "xyz789", + "entered_options": [EnteredOptionInput], + "quantity": 987.65, + "selected_options": [4], + "wishlist_item_id": "4" +} +``` + + + +### WishlistItems + +Contains an array of items in a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | + +#### Example + +```json +{ + "items": [WishlistItemInterface], + "page_info": SearchResultPageInfo +} +``` + + + +### WishlistOutput + +Deprecated: Use the `Wishlist` type instead. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | +| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | + +#### Example + +```json +{ + "items": [WishlistItem], + "items_count": 123, + "name": "abc123", + "sharing_code": "abc123", + "updated_at": "xyz789" +} +``` + + + +### WishlistVisibilityEnum + +Defines the wish list visibility types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PUBLIC` | | +| `PRIVATE` | | + +#### Example + +```json +""PUBLIC"" +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-mutations.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-mutations.md index a63fe697d..0bfc08858 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-mutations.md @@ -108,13 +108,13 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "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": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -125,8 +125,8 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", - "total_quantity": 123.45 + "template_id": 4, + "total_quantity": 987.65 } } } @@ -577,10 +577,7 @@ mutation addProductsToWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItems": [WishlistItemInput] -} +{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} ``` ##### Response @@ -968,10 +965,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemIds": ["4"] -} +{"wishlistId": 4, "wishlistItemIds": ["4"]} ``` ##### Response @@ -1141,7 +1135,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -1389,12 +1383,12 @@ mutation assignCustomerToGuestCart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, @@ -1480,7 +1474,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": false, "is_virtual": false, @@ -1618,8 +1612,8 @@ Change the password for the logged-in customer. | Name | Description | |------|-------------| -| `currentPassword` - [`String!`](#string) | The customer's original password. | -| `newPassword` - [`String!`](#string) | The customer's updated password. | +| `currentPassword` - [`String!`](#string) | The customer's original password. | +| `newPassword` - [`String!`](#string) | The customer's updated password. | #### Example @@ -1743,7 +1737,7 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", + "currentPassword": "xyz789", "newPassword": "xyz789" } ``` @@ -1760,32 +1754,32 @@ mutation changeCustomerPassword( "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], "date_of_birth": "abc123", - "default_billing": "abc123", + "default_billing": "xyz789", "default_shipping": "abc123", - "dob": "xyz789", - "email": "xyz789", + "dob": "abc123", + "email": "abc123", "firstname": "xyz789", - "gender": 987, + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "group_id": 987, "id": 4, - "is_subscribed": true, - "job_title": "abc123", - "lastname": "abc123", + "is_subscribed": false, + "job_title": "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": true, + "purchase_orders_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1795,11 +1789,11 @@ mutation changeCustomerPassword( "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", - "suffix": "xyz789", - "taxvat": "xyz789", + "structure_id": 4, + "suffix": "abc123", + "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -2114,7 +2108,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -2359,7 +2353,7 @@ mutation copyProductsBetweenWishlists( ```json { "sourceWishlistUid": 4, - "destinationWishlistUid": "4", + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } ``` @@ -2401,7 +2395,7 @@ mutation createBraintreeClientToken { ```json { "data": { - "createBraintreeClientToken": "xyz789" + "createBraintreeClientToken": "abc123" } } ``` @@ -2680,7 +2674,7 @@ mutation createCompareList($input: CreateCompareListInput) { "data": { "createCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": 4 } @@ -2800,27 +2794,27 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "country_id": "xyz789", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, - "default_billing": true, - "default_shipping": false, + "customer_id": 123, + "default_billing": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "abc123", - "id": 987, + "fax": "abc123", + "firstname": "xyz789", + "id": 123, "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, "street": ["xyz789"], "suffix": "abc123", - "telephone": "xyz789", + "telephone": "abc123", "uid": 4, "vat_id": "xyz789" } @@ -2905,7 +2899,7 @@ mutation createEmptyCart($input: createEmptyCartInput) { ##### Response ```json -{"data": {"createEmptyCart": "abc123"}} +{"data": {"createEmptyCart": "xyz789"}} ``` @@ -3036,9 +3030,9 @@ mutation createPayflowProToken($input: PayflowProTokenInput!) { "createPayflowProToken": { "response_message": "abc123", "result": 987, - "result_code": 123, - "secure_token": "xyz789", - "secure_token_id": "xyz789" + "result_code": 987, + "secure_token": "abc123", + "secure_token_id": "abc123" } } } @@ -3086,11 +3080,11 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 987.65, - "currency_code": "abc123", - "id": "abc123", - "mp_order_id": "abc123", - "status": "abc123" + "amount": 123.45, + "currency_code": "xyz789", + "id": "xyz789", + "mp_order_id": "xyz789", + "status": "xyz789" } } } @@ -3138,7 +3132,7 @@ mutation createPaypalExpressToken($input: PaypalExpressTokenInput!) { "data": { "createPaypalExpressToken": { "paypal_urls": PaypalExpressUrlList, - "token": "xyz789" + "token": "abc123" } } } @@ -3244,12 +3238,12 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "abc123", + "created_at": "xyz789", + "created_by": "xyz789", "description": "abc123", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "abc123" } } @@ -3388,7 +3382,7 @@ mutation createVaultCardSetupToken($input: CreateVaultCardSetupTokenInput!) { { "data": { "createVaultCardSetupToken": { - "setup_token": "abc123" + "setup_token": "xyz789" } } } @@ -3501,7 +3495,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3543,7 +3537,7 @@ mutation deleteCompanyUser($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3581,7 +3575,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3619,7 +3613,7 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -3649,7 +3643,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": true}} +{"data": {"deleteCustomer": false}} ``` @@ -3761,7 +3755,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": true}} +{"data": {"deleteNegotiableQuoteTemplate": false}} ``` @@ -3949,7 +3943,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -3959,7 +3953,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { "data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": true + "status": false } } } @@ -4005,7 +3999,7 @@ mutation deleteRequisitionListItems( ```json { "requisitionListUid": "4", - "requisitionListItemUids": ["4"] + "requisitionListItemUids": [4] } ``` @@ -4173,9 +4167,9 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "available": true, "base_amount": Money, "carrier_code": "abc123", - "carrier_title": "abc123", - "error_message": "abc123", - "method_code": "abc123", + "carrier_title": "xyz789", + "error_message": "xyz789", + "method_code": "xyz789", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -4267,7 +4261,7 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu "data": { "exchangeExternalCustomerToken": { "customer": Customer, - "token": "xyz789" + "token": "abc123" } } } @@ -4285,8 +4279,8 @@ Generate a token for specified customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -4310,7 +4304,7 @@ mutation generateCustomerToken( ```json { - "email": "xyz789", + "email": "abc123", "password": "abc123" } ``` @@ -4406,7 +4400,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom ##### Response ```json -{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}} +{ + "data": { + "generateNegotiableQuoteFromTemplate": { + "negotiable_quote_uid": "4" + } + } +} ``` @@ -4461,7 +4461,7 @@ Transfer the contents of a guest cart into the cart of a logged-in customer. | Name | Description | |------|-------------| -| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | +| `source_cart_id` - [`String!`](#string) | The guest's cart ID before they login. | | `destination_cart_id` - [`String`](#string) | The cart ID after the guest logs in. | #### Example @@ -4564,12 +4564,12 @@ mutation mergeCarts( "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "is_virtual": false, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -4621,7 +4621,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": 4, "giftRegistryUid": "4"} +{"cartUid": "4", "giftRegistryUid": 4} ``` ##### Response @@ -4683,7 +4683,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", + "sourceRequisitionListUid": 4, "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } @@ -4796,8 +4796,8 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", - "destinationWishlistUid": "4", + "sourceWishlistUid": 4, + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } ``` @@ -4888,13 +4888,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 123, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -4905,7 +4905,7 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45 } } @@ -4964,7 +4964,7 @@ Convert the quote into an order. | Name | Description | |------|-------------| -| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | +| `input` - [`PlaceOrderInput`](#placeorderinput) | An input object that defines the shopper's cart ID. | #### Example @@ -5139,7 +5139,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "xyz789", + "code": "abc123", "expiration_date": "abc123" } } @@ -5345,13 +5345,13 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response ```json -{"data": {"removeGiftRegistry": {"success": true}}} +{"data": {"removeGiftRegistry": {"success": false}}} ``` @@ -5392,7 +5392,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": [4]} +{"giftRegistryUid": 4, "itemsUid": ["4"]} ``` ##### Response @@ -5446,8 +5446,8 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, - "registrantsUid": ["4"] + "giftRegistryUid": "4", + "registrantsUid": [4] } ``` @@ -5623,10 +5623,10 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "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": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -5637,8 +5637,8 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, + "status": "abc123", + "template_id": "4", "total_quantity": 123.45 } } @@ -5691,7 +5691,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": 4 } @@ -5740,7 +5740,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": "4", "wishlistItemsIds": [4]} +{"wishlistId": 4, "wishlistItemsIds": [4]} ``` ##### Response @@ -5827,7 +5827,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -6014,7 +6014,7 @@ mutation requestGuestOrderCancel($input: GuestOrderCancelInput!) { { "data": { "requestGuestOrderCancel": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -6186,12 +6186,12 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "requestNegotiableQuoteTemplateFromQuote": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": true, + "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], @@ -6203,8 +6203,8 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, - "total_quantity": 123.45 + "template_id": "4", + "total_quantity": 987.65 } } } @@ -6222,7 +6222,7 @@ Request an email with a reset password token for the registered customer identif | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | +| `email` - [`String!`](#string) | The customer's email address. | #### Example @@ -6237,7 +6237,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -6329,7 +6329,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Response ```json -{"data": {"resendConfirmationEmail": false}} +{"data": {"resendConfirmationEmail": true}} ``` @@ -6344,9 +6344,9 @@ Reset a customer's password using the reset password token that the customer rec | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | -| `newPassword` - [`String!`](#string) | The customer's new password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `resetPasswordToken` - [`String!`](#string) | A runtime token generated by the `requestPasswordResetEmail` mutation. | +| `newPassword` - [`String!`](#string) | The customer's new password. | #### Example @@ -6370,16 +6370,16 @@ mutation resetPassword( ```json { - "email": "abc123", + "email": "xyz789", "resetPasswordToken": "abc123", - "newPassword": "xyz789" + "newPassword": "abc123" } ``` ##### Response ```json -{"data": {"resetPassword": true}} +{"data": {"resetPassword": false}} ``` @@ -6405,7 +6405,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": true}}} +{"data": {"revokeCustomerToken": {"result": false}}} ``` @@ -6583,7 +6583,7 @@ mutation setCartAsInactive($cartId: String!) { { "data": { "setCartAsInactive": { - "error": "xyz789", + "error": "abc123", "success": false } } @@ -6966,13 +6966,13 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 123, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -6982,8 +6982,8 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, + "status": "xyz789", + "template_id": "4", "total_quantity": 987.65 } } @@ -7163,9 +7163,9 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -7176,7 +7176,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, "total_quantity": 123.45 } @@ -7277,7 +7277,7 @@ Send an email about the gift registry to a list of invitees. | Name | Description | |------|-------------| | `giftRegistryUid` - [`ID!`](#id) | The unique ID of the gift registry. | -| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | +| `sender` - [`ShareGiftRegistrySenderInput!`](#sharegiftregistrysenderinput) | The sender's email address and gift message. | | `invitees` - [`[ShareGiftRegistryInviteeInput!]!`](#sharegiftregistryinviteeinput) | An array containing invitee names and email addresses. | #### Example @@ -7304,7 +7304,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7391,11 +7391,11 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "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": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -7424,7 +7424,7 @@ Subscribe the specified email to the store's newsletter. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | +| `email` - [`String!`](#string) | The email address that will receive the store's newsletter. | #### Example @@ -7483,7 +7483,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": false}} +{"data": {"syncPaymentOrder": true}} ``` @@ -7859,25 +7859,25 @@ mutation updateCustomerAddress( "data": { "updateCustomerAddress": { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country_code": "AF", "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], "customer_id": 123, - "default_billing": false, - "default_shipping": false, + "default_billing": true, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": 987, - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", + "id": 123, + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", "uid": "4", @@ -7969,7 +7969,7 @@ mutation updateCustomerAddressV2( "country_id": "abc123", "custom_attributes": [CustomerAddressAttribute], "custom_attributesV2": [AttributeValueInterface], - "customer_id": 123, + "customer_id": 987, "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], @@ -7977,16 +7977,16 @@ mutation updateCustomerAddressV2( "firstname": "xyz789", "id": 987, "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, "street": ["xyz789"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, - "vat_id": "abc123" + "telephone": "abc123", + "uid": "4", + "vat_id": "xyz789" } } } @@ -8004,8 +8004,8 @@ Change the email address for the logged-in customer. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The customer's email address. | -| `password` - [`String!`](#string) | The customer's password. | +| `email` - [`String!`](#string) | The customer's email address. | +| `password` - [`String!`](#string) | The customer's password. | #### Example @@ -8031,8 +8031,8 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", - "password": "xyz789" + "email": "xyz789", + "password": "abc123" } ``` @@ -8175,7 +8175,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "items": [UpdateGiftRegistryItemInput] } ``` @@ -8231,7 +8231,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -8459,9 +8459,9 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "created_at": "abc123", "created_by": "xyz789", "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -8507,7 +8507,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "input": UpdateRequisitionListInput } ``` @@ -8563,7 +8563,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [ UpdateRequisitionListItemsInput ] diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-queries.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-queries.md index 4aeb47256..6617a62b0 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-queries.md @@ -48,7 +48,7 @@ query attributesForm($formCode: String!) { ##### Variables ```json -{"formCode": "xyz789"} +{"formCode": "abc123"} ``` ##### Response @@ -409,13 +409,13 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "absolute_footer": "abc123", - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "abc123", + "absolute_footer": "xyz789", + "allow_gift_receipt": "xyz789", + "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", - "allow_order": "abc123", + "allow_guests_to_write_product_reviews": "abc123", + "allow_items": "abc123", + "allow_order": "xyz789", "allow_printed_card": "abc123", "autocomplete_on_storefront": false, "base_currency_code": "xyz789", @@ -425,233 +425,233 @@ query availableStores($useCurrentGroup: Boolean) { "base_url": "abc123", "braintree_3dsecure_allowspecific": true, "braintree_3dsecure_always_request_3ds": false, - "braintree_3dsecure_specificcountry": "xyz789", - "braintree_3dsecure_threshold_amount": "abc123", + "braintree_3dsecure_specificcountry": "abc123", + "braintree_3dsecure_threshold_amount": "xyz789", "braintree_3dsecure_verify_3dsecure": true, "braintree_ach_direct_debit_vault_active": false, "braintree_applepay_merchant_name": "xyz789", "braintree_applepay_vault_active": true, "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": true, - "braintree_environment": "abc123", - "braintree_googlepay_btn_color": "abc123", - "braintree_googlepay_cctypes": "xyz789", + "braintree_cc_vault_cvv": false, + "braintree_environment": "xyz789", + "braintree_googlepay_btn_color": "xyz789", + "braintree_googlepay_cctypes": "abc123", "braintree_googlepay_merchant_id": "abc123", - "braintree_googlepay_vault_active": true, + "braintree_googlepay_vault_active": false, "braintree_local_payment_allowed_methods": "abc123", "braintree_local_payment_fallback_button_text": "xyz789", "braintree_local_payment_redirect_on_fail": "xyz789", - "braintree_merchant_account_id": "abc123", + "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_show": false, + "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_text_color": "abc123", - "braintree_paypal_button_location_cart_type_paylater_color": "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_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_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": "xyz789", + "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_messaging_layout": "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_logo": "abc123", + "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": "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_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": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_shape": "abc123", - "braintree_paypal_button_location_checkout_type_paypal_show": true, + "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": "xyz789", + "braintree_paypal_button_location_checkout_type_paypal_show": false, "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": "abc123", - "braintree_paypal_button_location_productpage_type_messaging_logo": "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": "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": "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": "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": "xyz789", - "braintree_paypal_button_location_productpage_type_paypal_label": "abc123", - "braintree_paypal_button_location_productpage_type_paypal_shape": "xyz789", - "braintree_paypal_button_location_productpage_type_paypal_show": false, + "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": "xyz789", + "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": true, - "braintree_paypal_merchant_country": "abc123", + "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_merchant_country": "xyz789", "braintree_paypal_merchant_name_override": "abc123", "braintree_paypal_require_billing_address": false, "braintree_paypal_send_cart_line_items": false, "braintree_paypal_vault_active": false, - "cart_expires_in_days": 987, + "cart_expires_in_days": 123, "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", - "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, + "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": false, - "check_money_order_make_check_payable_to": "xyz789", + "category_url_suffix": "xyz789", + "check_money_order_enable_for_specific_countries": true, + "check_money_order_enabled": true, + "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": "xyz789", + "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_send_check_to": "abc123", "check_money_order_sort_order": 123, - "check_money_order_title": "xyz789", + "check_money_order_title": "abc123", "cms_home_page": "xyz789", "cms_no_cookies": "xyz789", "cms_no_route": "xyz789", - "code": "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": "abc123", - "default_description": "abc123", - "default_display_currency_code": "xyz789", - "default_keywords": "abc123", + "customer_access_token_lifetime": 123.45, + "default_country": "xyz789", + "default_description": "xyz789", + "default_display_currency_code": "abc123", + "default_keywords": "xyz789", "default_title": "abc123", - "demonotice": 123, - "display_product_prices_in_catalog": 123, + "demonotice": 987, + "display_product_prices_in_catalog": 987, "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, + "enable_multiple_wishlists": "abc123", + "fixed_product_taxes_apply_tax_to_fpt": true, + "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": 987, - "fixed_product_taxes_enable": true, + "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_include_fpt_in_subtotal": true, - "front": "xyz789", + "front": "abc123", "graphql_share_customer_group": true, - "grid_per_page": 987, - "grid_per_page_values": "abc123", + "grid_per_page": 123, + "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "head_includes": "abc123", - "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", + "head_includes": "xyz789", + "head_shortcut_icon": "abc123", + "header_logo_src": "abc123", "id": 987, "is_checkout_agreements_enabled": false, - "is_default_store": true, - "is_default_store_group": false, - "is_guest_checkout_enabled": true, + "is_default_store": false, + "is_default_store_group": true, + "is_guest_checkout_enabled": false, "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": false, - "is_requisition_list_active": "xyz789", - "list_mode": "abc123", + "is_requisition_list_active": "abc123", + "list_mode": "xyz789", "list_per_page": 123, "list_per_page_values": "xyz789", "locale": "xyz789", "logo_alt": "xyz789", "logo_height": 123, - "logo_width": 987, - "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "abc123", - "magento_reward_general_min_points_balance": "xyz789", + "logo_width": 123, + "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": "xyz789", - "magento_reward_points_invitation_customer_limit": "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_newsletter": "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": "xyz789", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "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": true, + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, "minicart_max_items": 123, "minimum_password_length": "abc123", "newsletter_enabled": false, "no_route": "xyz789", - "optional_zip_countries": "xyz789", + "optional_zip_countries": "abc123", "order_cancellation_enabled": true, "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": 987, - "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_shipping_amount": 123, "orders_invoices_credit_memos_display_subtotal": 123, "orders_invoices_credit_memos_display_zero_tax": true, "payment_payflowpro_cc_vault_active": "xyz789", - "printed_card_price": "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": false, - "required_character_classes_number": "abc123", - "returns_enabled": "abc123", + "product_url_suffix": "xyz789", + "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": "abc123", "sales_printed_card": "abc123", - "secure_base_link_url": "abc123", - "secure_base_media_url": "abc123", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "xyz789", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, "share_active_segments": true, - "share_applied_cart_rule": true, - "shopping_cart_display_full_summary": true, + "share_applied_cart_rule": false, + "shopping_cart_display_full_summary": false, "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 987, + "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 123, "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": "abc123", - "store_sort_order": 987, + "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", "title_prefix": "abc123", - "title_separator": "xyz789", - "title_suffix": "xyz789", + "title_separator": "abc123", + "title_suffix": "abc123", "use_store_in_url": false, "website_code": 4, - "website_id": 987, + "website_id": 123, "website_name": "xyz789", "weight_unit": "abc123", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": true, + "welcome": "xyz789", + "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", + "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_title": "abc123" + "zero_subtotal_title": "xyz789" } ] } @@ -759,11 +759,11 @@ query cart($cart_id: String!) { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "is_virtual": true, "items": [CartItemInterface], "itemsV2": CartItems, @@ -838,7 +838,7 @@ query categories( "categories": { "items": [CategoryTree], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -921,7 +921,7 @@ query category($id: Int) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -930,40 +930,40 @@ query category($id: Int) { { "data": { "category": { - "automatic_sorting": "abc123", - "available_sort_by": ["abc123"], + "automatic_sorting": "xyz789", + "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], "canonical_url": "xyz789", "children": [CategoryTree], - "children_count": "abc123", + "children_count": "xyz789", "cms_block": CmsBlock, "created_at": "xyz789", - "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", + "custom_layout_update_file": "xyz789", + "default_sort_by": "xyz789", "description": "xyz789", "display_mode": "xyz789", "filter_price_range": 123.45, - "id": 123, + "id": 987, "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 123, + "include_in_menu": 987, + "is_anchor": 987, "landing_page": 123, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "xyz789", + "level": 123, + "meta_description": "abc123", + "meta_keywords": "abc123", "meta_title": "abc123", - "name": "xyz789", + "name": "abc123", "path": "abc123", - "path_in_store": "abc123", + "path_in_store": "xyz789", "position": 987, "product_count": 123, "products": CategoryProducts, - "redirect_code": 987, + "redirect_code": 123, "relative_url": "xyz789", - "staged": true, + "staged": false, "type": "CMS_PAGE", "uid": "4", - "updated_at": "abc123", + "updated_at": "xyz789", "url_key": "abc123", "url_path": "xyz789", "url_suffix": "abc123" @@ -1078,36 +1078,36 @@ query categoryList( "breadcrumbs": [Breadcrumb], "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": "xyz789", + "custom_layout_update_file": "abc123", + "default_sort_by": "abc123", "description": "xyz789", "display_mode": "abc123", - "filter_price_range": 123.45, + "filter_price_range": 987.65, "id": 123, - "image": "xyz789", + "image": "abc123", "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 123, - "level": 123, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "name": "abc123", + "is_anchor": 123, + "landing_page": 987, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "name": "xyz789", "path": "abc123", "path_in_store": "xyz789", - "position": 987, + "position": 123, "product_count": 987, "products": CategoryProducts, "redirect_code": 123, - "relative_url": "xyz789", + "relative_url": "abc123", "staged": false, "type": "CMS_PAGE", - "uid": 4, + "uid": "4", "updated_at": "abc123", - "url_key": "xyz789", + "url_key": "abc123", "url_path": "abc123", "url_suffix": "abc123" } @@ -1149,11 +1149,11 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 987, - "checkbox_text": "xyz789", + "agreement_id": 123, + "checkbox_text": "abc123", "content": "abc123", "content_height": "xyz789", - "is_html": false, + "is_html": true, "mode": "AUTO", "name": "abc123" } @@ -1193,7 +1193,7 @@ query cmsBlocks($identifiers: [String]) { ##### Variables ```json -{"identifiers": ["abc123"]} +{"identifiers": ["xyz789"]} ``` ##### Response @@ -1249,7 +1249,7 @@ query cmsPage( ##### Variables ```json -{"id": 123, "identifier": "abc123"} +{"id": 123, "identifier": "xyz789"} ``` ##### Response @@ -1258,14 +1258,14 @@ query cmsPage( { "data": { "cmsPage": { - "content": "xyz789", - "content_heading": "xyz789", + "content": "abc123", + "content_heading": "abc123", "identifier": "abc123", "meta_description": "xyz789", "meta_keywords": "abc123", "meta_title": "xyz789", - "page_layout": "xyz789", - "redirect_code": 123, + "page_layout": "abc123", + "redirect_code": 987, "relative_url": "abc123", "title": "xyz789", "type": "CMS_PAGE", @@ -1348,9 +1348,9 @@ query company { "credit": CompanyCredit, "credit_history": CompanyCreditHistory, "email": "xyz789", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "abc123", "payment_methods": ["xyz789"], "reseller_id": "xyz789", @@ -1415,7 +1415,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -1457,9 +1457,9 @@ query countries { { "available_regions": [Region], "full_name_english": "xyz789", - "full_name_locale": "xyz789", - "id": "abc123", - "three_letter_abbreviation": "abc123", + "full_name_locale": "abc123", + "id": "xyz789", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" } ] @@ -1503,7 +1503,7 @@ query country($id: String) { ##### Variables ```json -{"id": "abc123"} +{"id": "xyz789"} ``` ##### Response @@ -1516,8 +1516,8 @@ query country($id: String) { "full_name_english": "abc123", "full_name_locale": "xyz789", "id": "abc123", - "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "xyz789" + "three_letter_abbreviation": "abc123", + "two_letter_abbreviation": "abc123" } } } @@ -1559,13 +1559,13 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "xyz789", + "base_currency_code": "abc123", "base_currency_symbol": "xyz789", - "default_display_currecy_code": "xyz789", - "default_display_currecy_symbol": "xyz789", - "default_display_currency_code": "abc123", + "default_display_currecy_code": "abc123", + "default_display_currecy_symbol": "abc123", + "default_display_currency_code": "xyz789", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -1799,28 +1799,28 @@ query customer { "customer": { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "xyz789", "default_shipping": "abc123", - "dob": "xyz789", - "email": "xyz789", + "dob": "abc123", + "email": "abc123", "firstname": "xyz789", "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", + "group_id": 987, + "id": "4", + "is_subscribed": true, + "job_title": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1842,7 +1842,7 @@ query customer { "suffix": "abc123", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist": Wishlist, "wishlist_v2": Wishlist, "wishlists": [Wishlist] @@ -1940,16 +1940,16 @@ query customerCart { AvailablePaymentMethod ], "billing_address": BillingCartAddress, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": "4", - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -2130,11 +2130,7 @@ query customerSegments($cartId: String!) { ##### Response ```json -{ - "data": { - "customerSegments": [{"uid": "4"}] - } -} +{"data": {"customerSegments": [{"uid": 4}]}} ``` @@ -2241,7 +2237,7 @@ query getHostedProUrl($input: HostedProUrlInput!) { { "data": { "getHostedProUrl": { - "secure_form_url": "abc123" + "secure_form_url": "xyz789" } } } @@ -2289,9 +2285,9 @@ query getPayflowLinkToken($input: PayflowLinkTokenInput!) { "data": { "getPayflowLinkToken": { "mode": "TEST", - "paypal_url": "abc123", - "secure_token": "abc123", - "secure_token_id": "xyz789" + "paypal_url": "xyz789", + "secure_token": "xyz789", + "secure_token_id": "abc123" } } } @@ -2401,7 +2397,7 @@ query getPaymentOrder( ```json { - "cartId": "abc123", + "cartId": "xyz789", "id": "abc123" } ``` @@ -2415,7 +2411,7 @@ query getPaymentOrder( "id": "xyz789", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } } } @@ -2543,7 +2539,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "abc123", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -2599,7 +2595,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -2608,20 +2604,20 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "abc123", + "message": "xyz789", "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } } } @@ -2639,7 +2635,7 @@ Search for gift registries by specifying a registrant email address. | Name | Description | |------|-------------| -| `email` - [`String!`](#string) | The registrant's email. | +| `email` - [`String!`](#string) | The registrant's email. | #### Example @@ -2661,7 +2657,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2671,12 +2667,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", - "event_title": "abc123", - "gift_registry_uid": 4, - "location": "abc123", + "event_date": "abc123", + "event_title": "xyz789", + "gift_registry_uid": "4", + "location": "xyz789", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ] } @@ -2727,12 +2723,12 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "data": { "giftRegistryIdSearch": [ { - "event_date": "xyz789", - "event_title": "abc123", + "event_date": "abc123", + "event_title": "xyz789", "gift_registry_uid": "4", "location": "abc123", "name": "abc123", - "type": "abc123" + "type": "xyz789" } ] } @@ -2784,9 +2780,9 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", + "firstName": "xyz789", "lastName": "xyz789", - "giftRegistryTypeUid": "4" + "giftRegistryTypeUid": 4 } ``` @@ -2801,7 +2797,7 @@ query giftRegistryTypeSearch( "event_title": "abc123", "gift_registry_uid": 4, "location": "xyz789", - "name": "abc123", + "name": "xyz789", "type": "xyz789" } ] @@ -2844,7 +2840,7 @@ query giftRegistryTypes { GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ] } @@ -2957,33 +2953,33 @@ query guestOrder($input: GuestOrderInformationInput!) { "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": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "grand_total": 123.45, - "id": "4", + "grand_total": 987.65, + "id": 4, "increment_id": "abc123", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "number": "xyz789", - "order_date": "xyz789", - "order_number": "xyz789", + "order_date": "abc123", + "order_number": "abc123", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "abc123", - "status": "xyz789", + "status": "abc123", "token": "xyz789", "total": OrderTotal } @@ -3097,25 +3093,25 @@ query guestOrderByToken($input: OrderTokenInput!) { "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": true, "gift_wrapping": GiftWrapping, - "grand_total": 987.65, - "id": 4, + "grand_total": 123.45, + "id": "4", "increment_id": "abc123", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", - "order_date": "xyz789", - "order_number": "xyz789", + "number": "xyz789", + "order_date": "abc123", + "order_number": "abc123", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, @@ -3123,8 +3119,8 @@ query guestOrderByToken($input: OrderTokenInput!) { "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "xyz789", - "token": "abc123", + "status": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -3166,7 +3162,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} ``` @@ -3198,7 +3194,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3236,13 +3232,13 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} ``` @@ -3312,7 +3308,7 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -3384,7 +3380,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -3399,21 +3395,21 @@ query negotiableQuote($uid: ID!) { "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "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" + "total_quantity": 123.45, + "uid": "4", + "updated_at": "abc123" } } } @@ -3480,7 +3476,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": "4"} +{"templateId": 4} ``` ##### Response @@ -3508,7 +3504,7 @@ query negotiableQuoteTemplate($templateId: ID!) { NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, + "template_id": "4", "total_quantity": 987.65 } } @@ -3839,7 +3835,7 @@ query products( ```json { - "search": "abc123", + "search": "xyz789", "filter": ProductAttributeFilterInput, "pageSize": 20, "currentPage": 1, @@ -3859,7 +3855,7 @@ query products( "page_info": SearchResultPageInfo, "sort_fields": SortFields, "suggestions": [SearchSuggestion], - "total_count": 123 + "total_count": 987 } } } @@ -3947,10 +3943,10 @@ query recaptchaV3Config { "badge_position": "xyz789", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "abc123", - "minimum_score": 987.65, - "theme": "xyz789", + "is_enabled": true, + "language_code": "xyz789", + "minimum_score": 123.45, + "theme": "abc123", "website_key": "abc123" } } @@ -3969,7 +3965,7 @@ Return the full details for a specified product, category, or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -3988,7 +3984,7 @@ query route($url: String!) { ##### Variables ```json -{"url": "abc123"} +{"url": "xyz789"} ``` ##### Response @@ -3997,8 +3993,8 @@ query route($url: String!) { { "data": { "route": { - "redirect_code": 123, - "relative_url": "abc123", + "redirect_code": 987, + "relative_url": "xyz789", "type": "CMS_PAGE" } } @@ -4277,40 +4273,40 @@ query storeConfig { { "data": { "storeConfig": { - "absolute_footer": "xyz789", + "absolute_footer": "abc123", "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order": "abc123", "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "xyz789", - "allow_order": "xyz789", - "allow_printed_card": "abc123", + "allow_items": "abc123", + "allow_order": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": false, "base_currency_code": "abc123", - "base_link_url": "xyz789", - "base_media_url": "abc123", + "base_link_url": "abc123", + "base_media_url": "xyz789", "base_static_url": "xyz789", - "base_url": "abc123", - "braintree_3dsecure_allowspecific": true, - "braintree_3dsecure_always_request_3ds": false, + "base_url": "xyz789", + "braintree_3dsecure_allowspecific": false, + "braintree_3dsecure_always_request_3ds": true, "braintree_3dsecure_specificcountry": "abc123", "braintree_3dsecure_threshold_amount": "xyz789", "braintree_3dsecure_verify_3dsecure": true, "braintree_ach_direct_debit_vault_active": true, - "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": "xyz789", - "braintree_googlepay_cctypes": "abc123", - "braintree_googlepay_merchant_id": "abc123", + "braintree_cc_vault_active": "abc123", + "braintree_cc_vault_cvv": true, + "braintree_environment": "abc123", + "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_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_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": "xyz789", "braintree_paypal_button_location_cart_type_credit_show": true, @@ -4320,69 +4316,69 @@ query storeConfig { "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": "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_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_paypal_color": "xyz789", - "braintree_paypal_button_location_cart_type_paypal_label": "xyz789", + "braintree_paypal_button_location_cart_type_paypal_label": "abc123", "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_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": "abc123", + "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_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": "xyz789", - "braintree_paypal_button_location_checkout_type_paylater_show": true, - "braintree_paypal_button_location_checkout_type_paypal_color": "xyz789", + "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": 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_shape": "abc123", "braintree_paypal_button_location_checkout_type_paypal_show": true, - "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": "abc123", - "braintree_paypal_button_location_productpage_type_credit_show": true, + "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": "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": "abc123", - "braintree_paypal_button_location_productpage_type_paylater_color": "xyz789", + "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_show": false, "braintree_paypal_button_location_productpage_type_paypal_color": "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_shape": "abc123", "braintree_paypal_button_location_productpage_type_paypal_show": false, - "braintree_paypal_credit_uk_merchant_name": "abc123", - "braintree_paypal_display_on_shopping_cart": false, + "braintree_paypal_credit_uk_merchant_name": "xyz789", + "braintree_paypal_display_on_shopping_cart": true, "braintree_paypal_merchant_country": "xyz789", - "braintree_paypal_merchant_name_override": "abc123", - "braintree_paypal_require_billing_address": false, - "braintree_paypal_send_cart_line_items": true, - "braintree_paypal_vault_active": false, - "cart_expires_in_days": 987, + "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": 123, "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "abc123", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "abc123", + "cart_merge_preference": "xyz789", + "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": false, "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "xyz789", + "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_payment_from_specific_countries": "xyz789", "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", @@ -4397,99 +4393,99 @@ query storeConfig { "countries_with_required_region": "xyz789", "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, - "default_country": "abc123", - "default_description": "xyz789", - "default_display_currency_code": "abc123", - "default_keywords": "xyz789", + "default_country": "xyz789", + "default_description": "abc123", + "default_display_currency_code": "xyz789", + "default_keywords": "abc123", "default_title": "xyz789", "demonotice": 987, "display_product_prices_in_catalog": 123, "display_shipping_prices": 123, - "display_state_if_optional": true, + "display_state_if_optional": false, "enable_multiple_wishlists": "abc123", "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_on_product_view_page": 987, - "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": false, + "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, + "graphql_share_customer_group": true, "grid_per_page": 123, - "grid_per_page_values": "abc123", + "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", "head_includes": "xyz789", "head_shortcut_icon": "xyz789", "header_logo_src": "xyz789", - "id": 987, + "id": 123, "is_checkout_agreements_enabled": true, "is_default_store": false, - "is_default_store_group": false, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "abc123", - "list_mode": "xyz789", - "list_per_page": 987, + "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": "xyz789", + "list_mode": "abc123", + "list_per_page": 123, "list_per_page_values": "abc123", - "locale": "abc123", + "locale": "xyz789", "logo_alt": "abc123", "logo_height": 987, - "logo_width": 123, + "logo_width": 987, "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_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "abc123", - "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", + "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_register": "abc123", + "magento_reward_points_register": "xyz789", "magento_reward_points_review": "abc123", - "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "abc123", + "magento_reward_points_review_limit": "xyz789", + "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 123, "maximum_number_of_wishlists": "xyz789", "minicart_display": false, "minicart_max_items": 123, "minimum_password_length": "abc123", - "newsletter_enabled": true, - "no_route": "abc123", - "optional_zip_countries": "xyz789", + "newsletter_enabled": false, + "no_route": "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": true, "orders_invoices_credit_memos_display_price": 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", - "printed_card_price": "abc123", + "printed_card_price": "xyz789", "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", + "product_reviews_enabled": "abc123", "product_url_suffix": "abc123", "quickorder_active": true, - "required_character_classes_number": "abc123", - "returns_enabled": "xyz789", + "required_character_classes_number": "xyz789", + "returns_enabled": "abc123", "root_category_id": 123, - "root_category_uid": "4", + "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": "abc123", + "secure_base_link_url": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "send_friend": SendFriendConfiguration, - "share_active_segments": false, + "share_active_segments": true, "share_applied_cart_rule": true, - "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": false, + "shopping_cart_display_full_summary": true, + "shopping_cart_display_grand_total": true, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 987, "shopping_cart_display_subtotal": 123, @@ -4497,25 +4493,25 @@ query storeConfig { "shopping_cart_display_zero_tax": true, "show_cms_breadcrumbs": 123, "store_code": "4", - "store_group_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_separator": "xyz789", - "title_suffix": "xyz789", - "use_store_in_url": false, - "website_code": 4, - "website_id": 123, + "title_separator": "abc123", + "title_suffix": "abc123", + "use_store_in_url": true, + "website_code": "4", + "website_id": 987, "website_name": "xyz789", - "weight_unit": "abc123", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", + "weight_unit": "xyz789", + "welcome": "xyz789", + "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enabled": false, + "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, "zero_subtotal_title": "abc123" } @@ -4539,7 +4535,7 @@ Return the relative URL for a specified product, category or CMS page. | Name | Description | |------|-------------| -| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | +| `url` - [`String!`](#string) | A `url_key` appended by the `url_suffix, if one exists. | #### Example @@ -4561,7 +4557,7 @@ query urlResolver($url: String!) { ##### Variables ```json -{"url": "xyz789"} +{"url": "abc123"} ``` ##### Response @@ -4570,10 +4566,10 @@ query urlResolver($url: String!) { { "data": { "urlResolver": { - "canonical_url": "abc123", - "entity_uid": "4", - "id": 123, - "redirectCode": 987, + "canonical_url": "xyz789", + "entity_uid": 4, + "id": 987, + "redirectCode": 123, "relative_url": "xyz789", "type": "CMS_PAGE" } @@ -4620,7 +4616,7 @@ query wishlist { "items": [WishlistItem], "items_count": 123, "name": "abc123", - "sharing_code": "abc123", + "sharing_code": "xyz789", "updated_at": "xyz789" } } diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-2.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-2.md deleted file mode 100644 index 68fb29b62..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-2.md +++ /dev/null @@ -1,6412 +0,0 @@ -### Currency - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | -| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | -| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | -| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | - -#### Example - -```json -{ - "available_currency_codes": ["abc123"], - "base_currency_code": "xyz789", - "base_currency_symbol": "xyz789", - "default_display_currecy_code": "xyz789", - "default_display_currecy_symbol": "abc123", - "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", - "exchange_rates": [ExchangeRate] -} -``` - - - -### CurrencyEnum - -The list of available currency codes. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""AFN"" -``` - - - -### CustomAttributeMetadata - -Defines an array of custom attributes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[Attribute]`](#attribute) | An array of attributes. | - -#### Example - -```json -{"items": [Attribute]} -``` - - - -### CustomAttributeMetadataInterface - -An interface containing fields that define the EAV attribute. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | - -#### Possible Types - -| CustomAttributeMetadataInterface Types | -|----------------| -| [`AttributeMetadata`](#attributemetadata) | -| [`CatalogAttributeMetadata`](#catalogattributemetadata) | -| [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | - -#### Example - -```json -{ - "code": "4", - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": true, - "label": "abc123", - "options": [CustomAttributeOptionInterface] -} -``` - - - -### CustomAttributeOptionInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | - -#### Possible Types - -| CustomAttributeOptionInterface Types | -|----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | - -#### Example - -```json -{ - "is_default": true, - "label": "xyz789", - "value": "xyz789" -} -``` - - - -### Customer - -Defines the customer name, addresses, and other details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | -| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | -| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | -| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | -| `email` - [`String`](#string) | The customer's email address. Required. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | -| `group` - [`CustomerGroupStorefront`](#customergroupstorefront) | Customer group assigned to the customer | -| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | -| `id` - [`ID!`](#id) | The unique ID assigned to the customer. | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | -| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | -| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | -| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | -| `segments` - [`[CustomerSegmentStorefront]`](#customersegmentstorefront) | Customer segments associated with the current customer | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | -| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | -| `telephone` - [`String`](#string) | The phone number of the company user. | -| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | -| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](#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. | - -#### Example - -```json -{ - "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": "xyz789", - "default_shipping": "abc123", - "dob": "abc123", - "email": "xyz789", - "firstname": "abc123", - "gender": 123, - "gift_registries": [GiftRegistry], - "gift_registry": GiftRegistry, - "group": CustomerGroupStorefront, - "group_id": 123, - "id": "4", - "is_subscribed": true, - "job_title": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "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": "xyz789", - "wishlist": Wishlist, - "wishlist_v2": Wishlist, - "wishlists": [Wishlist] -} -``` - - - -### CustomerAddress - -Contains detailed information about a customer's billing or shipping address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | -| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | -| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | -| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `uid` - [`ID`](#id) | The unique ID for a `CustomerAddress` object. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "country_id": "xyz789", - "custom_attributes": [CustomerAddressAttribute], - "custom_attributesV2": [AttributeValueInterface], - "customer_id": 987, - "default_billing": true, - "default_shipping": false, - "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", - "id": 123, - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", - "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "uid": 4, - "vat_id": "abc123" -} -``` - - - -### CustomerAddressAttribute - -Specifies the attribute code and value of a customer address attribute. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](#string) | The value assigned to the customer address attribute. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "value": "xyz789" -} -``` - - - -### CustomerAddressAttributeInput - -Specifies the attribute code and value of a customer attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | -| `value` - [`String!`](#string) | The value assigned to the attribute. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "xyz789" -} -``` - - - -### CustomerAddressInput - -Contains details about a billing or shipping address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | | -| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | | -| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "city": "abc123", - "company": "xyz789", - "country_code": "AF", - "country_id": "AF", - "custom_attributes": [CustomerAddressAttributeInput], - "custom_attributesV2": [AttributeValueInput], - "default_billing": true, - "default_shipping": true, - "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" -} -``` - - - -### CustomerAddressRegion - -Defines the customer's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "abc123", - "region_code": "xyz789", - "region_id": 123 -} -``` - - - -### CustomerAddressRegionInput - -Defines the customer's state or province. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "abc123", - "region_code": "abc123", - "region_id": 987 -} -``` - - - -### CustomerAddresses - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer addresses. | - -#### Example - -```json -{ - "items": [CustomerAddress], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerAttributeMetadata - -Customer attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | - -#### Example - -```json -{ - "code": 4, - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": false, - "is_unique": true, - "label": "abc123", - "multiline_count": 123, - "options": [CustomAttributeOptionInterface], - "sort_order": 987, - "validate_rules": [ValidationRule] -} -``` - - - -### CustomerCreateInput - -An input object for creating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | | -| `email` - [`String!`](#string) | The customer's email address. | -| `firstname` - [`String!`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "xyz789", - "dob": "xyz789", - "email": "abc123", - "firstname": "xyz789", - "gender": 987, - "is_subscribed": false, - "lastname": "xyz789", - "middlename": "xyz789", - "password": "xyz789", - "prefix": "xyz789", - "suffix": "abc123", - "taxvat": "xyz789" -} -``` - - - -### CustomerDownloadableProduct - -Contains details about a single downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date` - [`String`](#string) | The date and time the purchase was made. | -| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | - -#### Example - -```json -{ - "date": "xyz789", - "download_url": "xyz789", - "order_increment_id": "abc123", - "remaining_downloads": "abc123", - "status": "xyz789" -} -``` - - - -### CustomerDownloadableProducts - -Contains a list of downloadable products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | - -#### Example - -```json -{"items": [CustomerDownloadableProduct]} -``` - - - -### CustomerGroupStorefront - -Data of customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerGroup` object. | - -#### Example - -```json -{"uid": "4"} -``` - - - -### CustomerInput - -An input object that assigns or updates customer attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | | -| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "date_of_birth": "abc123", - "dob": "xyz789", - "email": "xyz789", - "firstname": "xyz789", - "gender": 123, - "is_subscribed": false, - "lastname": "xyz789", - "middlename": "abc123", - "password": "abc123", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "abc123" -} -``` - - - -### CustomerOrder - -Contains details about each of the customer's orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | -| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | -| `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | -| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | -| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | -| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `customer_info` - [`OrderCustomerInfo!`](#ordercustomerinfo) | Returns customer information from order. | -| `email` - [`String`](#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | -| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | -| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | -| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | -| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | -| `is_virtual` - [`Boolean!`](#boolean) | `TRUE` if the order is virtual | -| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | -| `number` - [`String!`](#string) | The order number. | -| `order_date` - [`String!`](#string) | The date the order was placed. | -| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | -| `order_status_change_date` - [`String!`](#string) | The date the order status was last updated. | -| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](#string) | The delivery method for the order. | -| `status` - [`String!`](#string) | The current status of the order. | -| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | - -#### Example - -```json -{ - "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": "abc123", - "gift_message": GiftMessage, - "gift_receipt_included": false, - "gift_wrapping": GiftWrapping, - "grand_total": 987.65, - "id": "4", - "increment_id": "abc123", - "invoices": [Invoice], - "is_virtual": false, - "items": [OrderItemInterface], - "items_eligible_for_return": [OrderItemInterface], - "number": "abc123", - "order_date": "xyz789", - "order_number": "abc123", - "order_status_change_date": "xyz789", - "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, - "returns": Returns, - "shipments": [OrderShipment], - "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", - "token": "abc123", - "total": OrderTotal -} -``` - - - -### CustomerOrderSortInput - -CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | -| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "NUMBER"} -``` - - - -### CustomerOrderSortableField - -Specifies the field to use for sorting - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NUMBER` | Sorts customer orders by number | -| `CREATED_AT` | Sorts customer orders by created_at field | - -#### Example - -```json -""NUMBER"" -``` - - - -### CustomerOrders - -The collection of orders that match the conditions defined in the filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | -| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer orders. | - -#### Example - -```json -{ - "date_of_first_order": "xyz789", - "items": [CustomerOrder], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### CustomerOrdersFilterInput - -Identifies the filter to use for filtering orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `grand_total` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order base grand total value. | -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | -| `order_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order created_at time. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filters by order status. | - -#### Example - -```json -{ - "grand_total": FilterRangeTypeInput, - "number": FilterStringTypeInput, - "order_date": FilterRangeTypeInput, - "status": FilterEqualTypeInput -} -``` - - - -### CustomerOutput - -Contains details about a newly-created or updated customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | - -#### Example - -```json -{"customer": Customer} -``` - - - -### CustomerPaymentTokens - -Contains payment tokens stored in the customer's vault. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | - -#### Example - -```json -{"items": [PaymentToken]} -``` - - - -### CustomerSegmentStorefront - -Customer segment details - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerSegment` object. | - -#### Example - -```json -{"uid": 4} -``` - - - -### CustomerStoreCredit - -Contains store credit information with balance and history. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance_history` - [`CustomerStoreCreditHistory`](#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. | -| `current_balance` - [`Money`](#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | - -#### Example - -```json -{ - "balance_history": CustomerStoreCreditHistory, - "current_balance": Money, - "enabled": true -} -``` - - - -### CustomerStoreCreditHistory - -Lists changes to the amount of store credit available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of items returned. | - -#### Example - -```json -{ - "items": [CustomerStoreCreditHistoryItem], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerStoreCreditHistoryItem - -Contains store credit history information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `action` - [`String`](#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | - -#### Example - -```json -{ - "action": "xyz789", - "actual_balance": Money, - "balance_change": Money, - "date_time_changed": "abc123" -} -``` - - - -### CustomerToken - -Contains a customer authorization token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | - -#### Example - -```json -{"token": "abc123"} -``` - - - -### CustomerUpdateInput - -An input object for updating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `dob` - [`String`](#string) | | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", - "dob": "abc123", - "firstname": "xyz789", - "gender": 123, - "is_subscribed": true, - "lastname": "xyz789", - "middlename": "xyz789", - "prefix": "xyz789", - "suffix": "xyz789", - "taxvat": "abc123" -} -``` - - - -### CustomizableAreaOption - -Contains information about a text area that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | - -#### Example - -```json -{ - "option_id": 123, - "product_sku": "xyz789", - "required": true, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": CustomizableAreaValue -} -``` - - - -### CustomizableAreaValue - -Defines the price and sku of a product whose page contains a customized text area. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | - -#### Example - -```json -{ - "max_characters": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableCheckboxOption - -Contains information about a set of checkbox values that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | - -#### Example - -```json -{ - "option_id": 987, - "required": true, - "sort_order": 987, - "title": "xyz789", - "uid": 4, - "value": [CustomizableCheckboxValue] -} -``` - - - -### CustomizableCheckboxValue - -Defines the price and sku of a product whose page contains a customized set of checkbox values. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | - -#### Example - -```json -{ - "option_type_id": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### CustomizableDateOption - -Contains information about a date picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "abc123", - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": 4, - "value": CustomizableDateValue -} -``` - - - -### CustomizableDateTypeEnum - -Defines the customizable date type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `DATE` | | -| `DATE_TIME` | | -| `TIME` | | - -#### Example - -```json -""DATE"" -``` - - - -### CustomizableDateValue - -Defines the price and sku of a product whose page contains a customized date picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | - -#### Example - -```json -{ - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "type": "DATE", - "uid": "4" -} -``` - - - -### CustomizableDropDownOption - -Contains information about a drop down menu that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | - -#### Example - -```json -{ - "option_id": 987, - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": "4", - "value": [CustomizableDropDownValue] -} -``` - - - -### CustomizableDropDownValue - -Defines the price and sku of a product whose page contains a customized drop down menu. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableFieldOption - -Contains information about a text field that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "abc123", - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": CustomizableFieldValue -} -``` - - - -### CustomizableFieldValue - -Defines the price and sku of a product whose page contains a customized text field. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | - -#### Example - -```json -{ - "max_characters": 987, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "uid": 4 -} -``` - - - -### CustomizableFileOption - -Contains information about a file picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | - -#### Example - -```json -{ - "option_id": 987, - "product_sku": "xyz789", - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": CustomizableFileValue -} -``` - - - -### CustomizableFileValue - -Defines the price and sku of a product whose page contains a customized file picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `file_extension` - [`String`](#string) | The file extension to accept. | -| `image_size_x` - [`Int`](#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](#int) | The maximum height of an image. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | - -#### Example - -```json -{ - "file_extension": "abc123", - "image_size_x": 123, - "image_size_y": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableMultipleOption - -Contains information about a multiselect that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | - -#### Example - -```json -{ - "option_id": 987, - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": 4, - "value": [CustomizableMultipleValue] -} -``` - - - -### CustomizableMultipleValue - -Defines the price and sku of a product whose page contains a customized multiselect. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 123, - "title": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableOptionInput - -Defines a customizable option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`Int`](#int) | The customizable option ID of the product. | -| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](#string) | The string value of the option. | - -#### Example - -```json -{ - "id": 987, - "uid": "4", - "value_string": "abc123" -} -``` - - - -### CustomizableOptionInterface - -Contains basic information about a customizable option. It can be implemented by several types of configurable options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | - -#### Possible Types - -| CustomizableOptionInterface Types | -|----------------| -| [`CustomizableAreaOption`](#customizableareaoption) | -| [`CustomizableDateOption`](#customizabledateoption) | -| [`CustomizableDropDownOption`](#customizabledropdownoption) | -| [`CustomizableMultipleOption`](#customizablemultipleoption) | -| [`CustomizableFieldOption`](#customizablefieldoption) | -| [`CustomizableFileOption`](#customizablefileoption) | -| [`CustomizableRadioOption`](#customizableradiooption) | -| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | - -#### Example - -```json -{ - "option_id": 987, - "required": true, - "sort_order": 987, - "title": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableProductInterface - -Contains information about customizable product options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | - -#### Possible Types - -| CustomizableProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | - -#### Example - -```json -{"options": [CustomizableOptionInterface]} -``` - - - -### CustomizableRadioOption - -Contains information about a set of radio buttons that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | - -#### Example - -```json -{ - "option_id": 987, - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": 4, - "value": [CustomizableRadioValue] -} -``` - - - -### CustomizableRadioValue - -Defines the price and sku of a product whose page contains a customized set of radio buttons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "xyz789", - "uid": "4" -} -``` - - - -### DeleteCompanyRoleOutput - -Contains the response to the request to delete the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyTeamOutput - -Contains the status of the request to delete a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyUserOutput - -Contains the response to the request to delete the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompareListOutput - -Contains the results of the request to delete a compare list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | - -#### Example - -```json -{"result": true} -``` - - - -### DeleteNegotiableQuoteError - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | - -#### Example - -```json -NegotiableQuoteInvalidStateError -``` - - - -### DeleteNegotiableQuoteOperationFailure - -Contains details about a failed delete operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" -} -``` - - - -### DeleteNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | - -#### Example - -```json -NegotiableQuoteUidOperationSuccess -``` - - - -### DeleteNegotiableQuoteTemplateInput - -Specifies the quote template id of the quote template to delete - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### DeleteNegotiableQuotesInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | - -#### Example - -```json -{"quote_uids": [4]} -``` - - - -### DeleteNegotiableQuotesOutput - -Contains a list of undeleted negotiable quotes the company user can view. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | -| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | - -#### Example - -```json -{ - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} -``` - - - -### DeletePaymentTokenOutput - -Indicates whether the request succeeded and returns the remaining customer payment tokens. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | - -#### Example - -```json -{ - "customerPaymentTokens": CustomerPaymentTokens, - "result": true -} -``` - - - -### DeletePurchaseOrderApprovalRuleError - -Contains details about an error that occurred when deleting an approval rule . - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | -| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | - -#### Example - -```json -{"message": "xyz789", "type": "UNDEFINED"} -``` - - - -### DeletePurchaseOrderApprovalRuleErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `NOT_FOUND` | | - -#### Example - -```json -""UNDEFINED"" -``` - - - -### DeletePurchaseOrderApprovalRuleInput - -Specifies the IDs of the approval rules to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | - -#### Example - -```json -{"approval_rule_uids": ["4"]} -``` - - - -### DeletePurchaseOrderApprovalRuleOutput - -Contains any errors encountered while attempting to delete approval rules. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | - -#### Example - -```json -{"errors": [DeletePurchaseOrderApprovalRuleError]} -``` - - - -### DeleteRequisitionListItemsOutput - -Output of the request to remove items from the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### DeleteRequisitionListOutput - -Indicates whether the request to delete the requisition list was successful. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | - -#### Example - -```json -{"requisition_lists": RequisitionLists, "status": true} -``` - - - -### DeleteWishlistOutput - -Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | - -#### Example - -```json -{"status": true, "wishlists": [Wishlist]} -``` - - - -### Discount - -Specifies the discount type and value for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | -| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](#string) | A description of the discount. | -| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](#float) | Quote line item discount value. | - -#### Example - -```json -{ - "amount": Money, - "applied_to": "ITEM", - "coupon": AppliedCoupon, - "is_discounting_locked": false, - "label": "xyz789", - "type": "abc123", - "value": 987.65 -} -``` - - - -### DownloadableCartItem - -An implementation for downloadable product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "id": "abc123", - "is_available": false, - "links": [DownloadableProductLinks], - "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": 123.45, - "samples": [DownloadableProductSamples], - "uid": "4" -} -``` - - - -### DownloadableCreditMemoItem - -Defines downloadable product options for `CreditMemoItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 123.45 -} -``` - - - -### DownloadableFileTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | - -#### Example - -```json -""FILE"" -``` - - - -### DownloadableInvoiceItem - -Defines downloadable product options for `InvoiceItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 987.65 -} -``` - - - -### DownloadableItemsLinks - -Defines characteristics of the links for downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | - -#### Example - -```json -{ - "sort_order": 123, - "title": "abc123", - "uid": 4 -} -``` - - - -### DownloadableOrderItem - -Defines downloadable product options for `OrderItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "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": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### DownloadableProduct - -Defines a product that the shopper downloads. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | -| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "downloadable_product_links": [ - DownloadableProductLinks - ], - "downloadable_product_samples": [ - DownloadableProductSamples - ], - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "links_purchased_separately": 123, - "links_title": "xyz789", - "manufacturer": 987, - "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": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 987.65, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 123, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": false, - "stock_status": "IN_STOCK", - "swatch_image": "abc123", - "thumbnail": ProductImage, - "tier_price": 123.45, - "tier_prices": [ProductTierPrices], - "type": "CMS_PAGE", - "type_id": "xyz789", - "uid": "4", - "updated_at": "xyz789", - "upsell_products": [ProductInterface], - "url_key": "abc123", - "url_path": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website] -} -``` - - - -### DownloadableProductCartItemInput - -Defines a single downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | -| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "downloadable_product_links": [ - DownloadableProductLinksInput - ] -} -``` - - - -### DownloadableProductLinks - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | -| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `price` - [`Float`](#float) | The price of the downloadable product. | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | - -#### Example - -```json -{ - "id": 987, - "is_shareable": true, - "link_type": "FILE", - "number_of_downloads": 123, - "price": 987.65, - "sample_file": "xyz789", - "sample_type": "FILE", - "sample_url": "xyz789", - "sort_order": 987, - "title": "xyz789", - "uid": 4 -} -``` - - - -### DownloadableProductLinksInput - -Contains the link ID for the downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | - -#### Example - -```json -{"link_id": 987} -``` - - - -### DownloadableProductSamples - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | -| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the sample. | - -#### Example - -```json -{ - "id": 987, - "sample_file": "abc123", - "sample_type": "FILE", - "sample_url": "xyz789", - "sort_order": 123, - "title": "xyz789" -} -``` - - - -### DownloadableRequisitionListItem - -Contains details about downloadable products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "links": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 987.65, - "samples": [DownloadableProductSamples], - "uid": "4" -} -``` - - - -### DownloadableWishlistItem - -A downloadable product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "links_v2": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 987.65, - "samples": [DownloadableProductSamples] -} -``` - - - -### DuplicateNegotiableQuoteInput - -Identifies a quote to be duplicated - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | - -#### Example - -```json -{ - "duplicated_quote_uid": "4", - "quote_uid": 4 -} -``` - - - -### DuplicateNegotiableQuoteOutput - -Contains the newly created negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### DynamicBlock - -Contains a single dynamic block. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | -| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | - -#### Example - -```json -{ - "content": ComplexTextValue, - "uid": "4" -} -``` - - - -### DynamicBlockLocationEnum - -Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CONTENT` | | -| `HEADER` | | -| `FOOTER` | | -| `LEFT` | | -| `RIGHT` | | - -#### Example - -```json -""CONTENT"" -``` - - - -### DynamicBlockTypeEnum - -Indicates the selected Dynamic Blocks Rotator inline widget. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SPECIFIED` | | -| `CART_PRICE_RULE_RELATED` | | -| `CATALOG_PRICE_RULE_RELATED` | | - -#### Example - -```json -""SPECIFIED"" -``` - - - -### DynamicBlocks - -Contains an array of dynamic blocks. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | - -#### Example - -```json -{ - "items": [DynamicBlock], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### DynamicBlocksFilterInput - -Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | -| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | -| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | - -#### Example - -```json -{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"} -``` - - - -### EnteredCustomAttributeInput - -Contains details about a custom text attribute that the buyer entered. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "abc123" -} -``` - - - -### EnteredOptionInput - -Defines a customer-entered option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](#string) | Text the customer entered. | - -#### Example - -```json -{ - "uid": "4", - "value": "abc123" -} -``` - - - -### EntityUrl - -Contains the `uid`, `relative_url`, and `type` attributes. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | -| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | -| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Example - -```json -{ - "canonical_url": "abc123", - "entity_uid": 4, - "id": 123, - "redirectCode": 987, - "relative_url": "abc123", - "type": "CMS_PAGE" -} -``` - - - -### Error - -An error encountered while adding an item to the the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Possible Types - -| Error Types | -|----------------| -| [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](#insufficientstockerror) | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" -} -``` - - - -### ErrorInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Possible Types - -| ErrorInterface Types | -|----------------| -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | - -#### Example - -```json -{"message": "xyz789"} -``` - - - -### EstimateAddressInput - -Contains details about an address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | - -#### Example - -```json -{ - "country_code": "AF", - "postcode": "abc123", - "region": CustomerAddressRegionInput -} -``` - - - -### EstimateTotalsInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | - -#### Example - -```json -{ - "address": EstimateAddressInput, - "cart_id": "abc123", - "shipping_method": ShippingMethodInput -} -``` - - - -### EstimateTotalsOutput - -Estimate totals output. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | Cart after totals estimation | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ExchangeExternalCustomerTokenInput - -Contains details about external customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer characteristics to update. | - -#### Example - -```json -{"customer": CustomerCreateInput} -``` - - - -### ExchangeExternalCustomerTokenOutput - -Contains customer token for external customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | -| `token` - [`String!`](#string) | The customer authorization token. | - -#### Example - -```json -{ - "customer": Customer, - "token": "xyz789" -} -``` - - - -### ExchangeRate - -Lists the exchange rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | - -#### Example - -```json -{"currency_to": "xyz789", "rate": 987.65} -``` - - - -### FastlaneConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "code": "abc123", - "is_visible": false, - "payment_intent": "abc123", - "payment_source": "abc123", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds_mode": "OFF", - "title": "abc123" -} -``` - - - -### FastlaneMethodInput - -Fastlane Payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `paypal_fastlane_token` - [`String`](#string) | The single use token from Fastlane | - -#### Example - -```json -{ - "payment_source": "xyz789", - "paypal_fastlane_token": "abc123" -} -``` - - - -### FilterEqualTypeInput - -Defines a filter that matches the input exactly. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#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]`](#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 - -```json -{ - "eq": "xyz789", - "in": ["abc123"] -} -``` - - - -### FilterMatchTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FULL` | | -| `PARTIAL` | | - -#### Example - -```json -""FULL"" -``` - - - -### FilterMatchTypeInput - -Defines a filter that performs a fuzzy search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `match` - [`String`](#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`](#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 - -```json -{"match": "abc123", "match_type": "FULL"} -``` - - - -### FilterRangeTypeInput - -Defines a filter that matches a range of values, such as prices or dates. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | - -#### Example - -```json -{ - "from": "abc123", - "to": "xyz789" -} -``` - - - -### FilterStringTypeInput - -Defines a filter for an input string. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | - -#### Example - -```json -{ - "eq": "xyz789", - "in": ["abc123"], - "match": "xyz789" -} -``` - - - -### FilterTypeInput - -Defines the comparison operators that can be used in a filter. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Equals. | -| `finset` - [`[String]`](#string) | | -| `from` - [`String`](#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](#string) | Greater than. | -| `gteq` - [`String`](#string) | Greater than or equal to. | -| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](#string) | Less than. | -| `lteq` - [`String`](#string) | Less than or equal to. | -| `moreq` - [`String`](#string) | More than or equal to. | -| `neq` - [`String`](#string) | Not equal to. | -| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](#string) | Not null. | -| `null` - [`String`](#string) | Is null. | -| `to` - [`String`](#string) | To. Must be used with the `from` field. | - -#### Example - -```json -{ - "eq": "abc123", - "finset": ["xyz789"], - "from": "xyz789", - "gt": "abc123", - "gteq": "xyz789", - "in": ["xyz789"], - "like": "abc123", - "lt": "xyz789", - "lteq": "abc123", - "moreq": "xyz789", - "neq": "xyz789", - "nin": ["xyz789"], - "notnull": "abc123", - "null": "abc123", - "to": "xyz789" -} -``` - - - -### FixedProductTax - -A single FPT that can be applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | - -#### Example - -```json -{ - "amount": Money, - "label": "abc123" -} -``` - - - -### FixedProductTaxDisplaySettings - -Lists display settings for the Fixed Product Tax. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""INCLUDE_FPT_WITHOUT_DETAILS"" -``` - - - -### Float - -The `Float` scalar type represents signed double-precision fractional -values as specified by -[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -#### Example - -```json -987.65 -``` - - - -### GenerateCustomerTokenAsAdminInput - -Identifies which customer requires remote shopping assistance. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | - -#### Example - -```json -{"customer_email": "xyz789"} -``` - - - -### GenerateCustomerTokenAsAdminOutput - -Contains the generated customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | - -#### Example - -```json -{"customer_token": "xyz789"} -``` - - - -### GenerateNegotiableQuoteFromTemplateInput - -Specifies the template id, from which to generate quote from. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### GenerateNegotiableQuoteFromTemplateOutput - -Contains the generated negotiable quote id. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | - -#### Example - -```json -{"negotiable_quote_uid": "4"} -``` - - - -### GetPaymentSDKOutput - -Gets the payment SDK URLs and values - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | - -#### Example - -```json -{"sdkParams": [PaymentSDKParamsItem]} -``` - - - -### GiftCardAccount - -Contains details about the gift card account. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`Money`](#money) | The balance remaining on the gift card. | -| `code` - [`String`](#string) | The gift card account code. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | - -#### Example - -```json -{ - "balance": Money, - "code": "abc123", - "expiration_date": "abc123" -} -``` - - - -### GiftCardAccountInput - -Contains the gift card code. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | - -#### Example - -```json -{"gift_card_code": "abc123"} -``` - - - -### GiftCardAmounts - -Contains the value of a gift card, the website that generated the card, and related information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_id` - [`Int`](#int) | An internal attribute ID. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | -| `value` - [`Float`](#float) | The value of the gift card. | -| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | -| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | -| `website_value` - [`Float`](#float) | The value of the gift card. | - -#### Example - -```json -{ - "attribute_id": 987, - "uid": "4", - "value": 987.65, - "value_id": 123, - "website_id": 123, - "website_value": 123.45 -} -``` - - - -### GiftCardCartItem - -Contains details about a gift card that has been added to a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender. | -| `sender_name` - [`String!`](#string) | The name of the sender. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "amount": Money, - "available_gift_wrapping": [GiftWrapping], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "abc123", - "is_available": false, - "max_qty": 987.65, - "message": "xyz789", - "min_qty": 987.65, - "not_available_message": "abc123", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "xyz789", - "uid": "4" -} -``` - - - -### GiftCardCreditMemoItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 -} -``` - - - -### GiftCardInvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### GiftCardItem - -Contains details about a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | - -#### Example - -```json -{ - "message": "abc123", - "recipient_email": "abc123", - "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "abc123" -} -``` - - - -### GiftCardOptions - -Contains details about the sender, recipient, and amount of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](#string) | A message to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | - -#### Example - -```json -{ - "amount": Money, - "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "abc123", - "sender_email": "abc123", - "sender_name": "abc123" -} -``` - - - -### GiftCardOrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "eligible_for_return": false, - "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": "xyz789", - "product_type": "xyz789", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### GiftCardProduct - -Defines properties of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | -| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | -| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "allow_message": true, - "allow_open_amount": true, - "attribute_set_id": 987, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": false, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "giftcard_amounts": [GiftCardAmounts], - "giftcard_type": "VIRTUAL", - "id": 987, - "image": ProductImage, - "is_redeemable": true, - "is_returnable": "abc123", - "lifetime": 987, - "manufacturer": 123, - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "message_max_length": 123, - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "open_amount_max": 123.45, - "open_amount_min": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "rating_summary": 987.65, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "abc123", - "staged": false, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "tier_price": 987.65, - "tier_prices": [ProductTierPrices], - "type": "CMS_PAGE", - "type_id": "abc123", - "uid": "4", - "updated_at": "abc123", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website], - "weight": 123.45 -} -``` - - - -### GiftCardRequisitionListItem - -Contains details about gift cards added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "gift_card_options": GiftCardOptions, - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 -} -``` - - - -### GiftCardShipmentItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Example - -```json -{ - "gift_card": GiftCardItem, - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 -} -``` - - - -### GiftCardTypeEnum - -Specifies the gift card type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `VIRTUAL` | | -| `PHYSICAL` | | -| `COMBINED` | | - -#### Example - -```json -""VIRTUAL"" -``` - - - -### GiftCardWishlistItem - -A single gift card added to a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "gift_card_options": GiftCardOptions, - "id": "4", - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### GiftCartAttributeValue - -Gift card custom attribute value containing array data. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `options` - [`[String]!`](#string) | Array of gift card attribute option values. | - -#### Example - -```json -{ - "code": "4", - "options": ["xyz789"] -} -``` - - - -### GiftMessage - -Contains the text of a gift message, its sender, and recipient - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | - -#### Example - -```json -{ - "from": "xyz789", - "message": "abc123", - "to": "abc123" -} -``` - - - -### GiftMessageInput - -Defines a gift message. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String!`](#string) | The name of the sender. | -| `message` - [`String!`](#string) | The text of the gift message. | -| `to` - [`String!`](#string) | The name of the recepient. | - -#### Example - -```json -{ - "from": "abc123", - "message": "xyz789", - "to": "abc123" -} -``` - - - -### GiftOptionsPrices - -Contains prices for gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_items_incl_tax` - [`Money`](#money) | Price of the gift wrapping for all individual order items including tax. | -| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | -| `gift_wrapping_for_order_incl_tax` - [`Money`](#money) | Price of the gift wrapping for the whole order including tax. | -| `printed_card` - [`Money`](#money) | Price for the printed card. | -| `printed_card_incl_tax` - [`Money`](#money) | Price for the printed card including tax. | - -#### Example - -```json -{ - "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 -} -``` - - - -### GiftRegistry - -Contains details about a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | -| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | -| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | -| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | -| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | - -#### Example - -```json -{ - "created_at": "xyz789", - "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", - "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "xyz789", - "privacy_settings": "PRIVATE", - "registrants": [GiftRegistryRegistrant], - "shipping_address": CustomerAddress, - "status": "ACTIVE", - "type": GiftRegistryType, - "uid": 4 -} -``` - - - -### GiftRegistryDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": "4", - "group": "EVENT_INFORMATION", - "label": "xyz789", - "value": "xyz789" -} -``` - - - -### GiftRegistryDynamicAttributeGroup - -Defines the group type of a gift registry dynamic attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `EVENT_INFORMATION` | | -| `PRIVACY_SETTINGS` | | -| `REGISTRANT` | | -| `GENERAL_INFORMATION` | | -| `DETAILED_INFORMATION` | | -| `SHIPPING_ADDRESS` | | - -#### Example - -```json -""EVENT_INFORMATION"" -``` - - - -### GiftRegistryDynamicAttributeInput - -Defines a dynamic attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | - -#### Example - -```json -{ - "code": "4", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Possible Types - -| GiftRegistryDynamicAttributeInterface Types | -|----------------| -| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | -| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | - -#### Example - -```json -{ - "code": "4", - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeMetadata - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Example - -```json -{ - "attribute_group": "abc123", - "code": 4, - "input_type": "xyz789", - "is_required": true, - "label": "xyz789", - "sort_order": 123 -} -``` - - - -### GiftRegistryDynamicAttributeMetadataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Possible Types - -| GiftRegistryDynamicAttributeMetadataInterface Types | -|----------------| -| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | - -#### Example - -```json -{ - "attribute_group": "abc123", - "code": "4", - "input_type": "xyz789", - "is_required": false, - "label": "xyz789", - "sort_order": 987 -} -``` - - - -### GiftRegistryItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "abc123", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 987.65, - "uid": "4" -} -``` - - - -### GiftRegistryItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Possible Types - -| GiftRegistryItemInterface Types | -|----------------| -| [`GiftRegistryItem`](#giftregistryitem) | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "abc123", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 987.65, - "uid": 4 -} -``` - - - -### GiftRegistryItemUserErrorInterface - -Contains the status and any errors that encountered with the customer's gift register item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Possible Types - -| GiftRegistryItemUserErrorInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{ - "status": true, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### GiftRegistryItemsUserError - -Contains details about an error that occurred when processing a gift registry item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | -| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | -| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | -| `message` - [`String!`](#string) | A localized error message. | -| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | - -#### Example - -```json -{ - "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": 4, - "message": "xyz789", - "product_uid": 4 -} -``` - - - -### GiftRegistryItemsUserErrorType - -Defines the error type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""OUT_OF_STOCK"" -``` - - - -### GiftRegistryOutputInterface - -Contains the customer's gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | - -#### Possible Types - -| GiftRegistryOutputInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### GiftRegistryPrivacySettings - -Defines the privacy setting of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRIVATE` | | -| `PUBLIC` | | - -#### Example - -```json -""PRIVATE"" -``` - - - -### GiftRegistryRegistrant - -Contains details about a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryRegistrantDynamicAttribute - ], - "email": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "uid": "4" -} -``` - - - -### GiftRegistryRegistrantDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": "4", - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistrySearchResult - -Contains the results of a gift registry search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | -| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](#string) | The location of the event. | -| `name` - [`String!`](#string) | The name of the gift registry owner. | -| `type` - [`String`](#string) | The type of event being held. | - -#### Example - -```json -{ - "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": 4, - "location": "abc123", - "name": "abc123", - "type": "xyz789" -} -``` - - - -### GiftRegistryShippingAddressInput - -Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | -| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID assigned to this customer address. | - -#### Example - -```json -{ - "address_data": CustomerAddressInput, - "address_id": 4, - "customer_address_uid": 4 -} -``` - - - -### GiftRegistryStatus - -Defines the status of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ACTIVE` | | -| `INACTIVE` | | - -#### Example - -```json -""ACTIVE"" -``` - - - -### GiftRegistryType - -Contains details about a gift registry type. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | - -#### Example - -```json -{ - "dynamic_attributes_metadata": [ - GiftRegistryDynamicAttributeMetadataInterface - ], - "label": "xyz789", - "uid": 4 -} -``` - - - -### GiftWrapping - -Contains details about the selected or available gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | -| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | -| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | -| `price` - [`Money!`](#money) | The gift wrapping price. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | - -#### Example - -```json -{ - "design": "abc123", - "id": "4", - "image": GiftWrappingImage, - "price": Money, - "uid": 4 -} -``` - - - -### GiftWrappingImage - -Points to an image associated with a gift wrapping option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | - -#### Example - -```json -{ - "label": "abc123", - "url": "xyz789" -} -``` - - - -### GooglePayButtonStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | - -#### Example - -```json -{ - "color": "abc123", - "height": 123, - "type": "abc123" -} -``` - - - -### GooglePayConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "button_styles": GooglePayButtonStyles, - "code": "xyz789", - "is_visible": true, - "payment_intent": "abc123", - "payment_source": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "three_ds_mode": "OFF", - "title": "abc123" -} -``` - - - -### GooglePayMethodInput - -Google Pay inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" -} -``` - - - -### GroupedProduct - -Defines a grouped product, which consists of simple standalone products that are presented as a group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "abc123", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 987, - "image": ProductImage, - "is_returnable": "abc123", - "items": [GroupedProductItem], - "manufacturer": 987, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "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": "abc123", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website], - "weight": 987.65 -} -``` - - - -### GroupedProductItem - -Contains information about an individual grouped product item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | -| `qty` - [`Float`](#float) | The quantity of this grouped product item. | - -#### Example - -```json -{ - "position": 987, - "product": ProductInterface, - "qty": 123.45 -} -``` - - - -### GroupedProductWishlistItem - -A grouped product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### GuestOrderCancelInput - -Input to retrieve a guest order based on token. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `reason` - [`String!`](#string) | Cancellation reason. | -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{ - "reason": "xyz789", - "token": "xyz789" -} -``` - - - -### GuestOrderInformationInput - -Input to retrieve an order based on details. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `lastname` - [`String!`](#string) | Order billing address lastname. | -| `number` - [`String!`](#string) | Order number. | - -#### Example - -```json -{ - "email": "abc123", - "lastname": "xyz789", - "number": "xyz789" -} -``` - - - -### HostedFieldsConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cc_vault_code` - [`String`](#string) | Vault payment method code | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds` - [`Boolean`](#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "cc_vault_code": "abc123", - "code": "xyz789", - "is_vault_enabled": true, - "is_visible": true, - "payment_intent": "xyz789", - "payment_source": "xyz789", - "requires_card_details": false, - "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds": false, - "three_ds_mode": "OFF", - "title": "abc123" -} -``` - - - -### HostedFieldsInput - -Hosted Fields payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cardBin` - [`String`](#string) | Card bin number | -| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | -| `cardLast4` - [`String`](#string) | Last four digits of the card | -| `holderName` - [`String`](#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cardBin": "abc123", - "cardExpiryMonth": "xyz789", - "cardExpiryYear": "abc123", - "cardLast4": "abc123", - "holderName": "abc123", - "is_active_payment_token_enabler": true, - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" -} -``` - - - -### HostedProInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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 - -```json -{ - "cancel_url": "xyz789", - "return_url": "abc123" -} -``` - - - -### HostedProUrl - -Contains the secure URL used for the Payments Pro Hosted Solution payment method. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | - -#### Example - -```json -{"secure_form_url": "abc123"} -``` - - - -### HostedProUrlInput - -Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### HttpQueryParameter - -Contains target path parameters. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | A parameter name. | -| `value` - [`String`](#string) | A parameter value. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### ID - -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 - -```json -"4" -``` - - - -### ImageSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{ - "thumbnail": "xyz789", - "value": "xyz789" -} -``` - - - -### InputFilterEnum - -List of templates/filters applied to customer attribute input. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""NONE"" -``` - - - -### InsufficientStockError - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | -| `quantity` - [`Float`](#float) | Amount of available stock | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "quantity": 987.65 -} -``` - - - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. - -#### Example - -```json -987 -``` - - - -### InternalError - -Contains an error message when an internal error occurred. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "xyz789"} -``` - - - -### Invoice - -Contains invoice details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | -| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | -| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](#string) | Sequential invoice number. | -| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": 4, - "items": [InvoiceItemInterface], - "number": "abc123", - "total": InvoiceTotal -} -``` - - - -### InvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 987.65 -} -``` - - - -### InvoiceItemInterface - -Contains detailes about invoiced items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Possible Types - -| InvoiceItemInterface Types | -|----------------| -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | -| [`InvoiceItem`](#invoiceitem) | - -#### Example - -```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 -} -``` - - - -### InvoiceTotal - -Contains price details from an invoice. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### IsCompanyAdminEmailAvailableOutput - -Contains the response of a company admin email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsCompanyEmailAvailableOutput - -Contains the response of a company email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsCompanyRoleNameAvailableOutput - -Contains the response of a role name validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | - -#### Example - -```json -{"is_role_name_available": false} -``` - - - -### IsCompanyUserEmailAvailableOutput - -Contains the response of a company user email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsEmailAvailableOutput - -Contains the result of the `isEmailAvailable` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### ItemNote - -The note object for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | -| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | -| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | -| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | -| `note` - [`String`](#string) | Note text. | -| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | - -#### Example - -```json -{ - "created_at": "abc123", - "creator_id": 987, - "creator_type": 123, - "negotiable_quote_item_uid": "4", - "note": "abc123", - "note_uid": "4" -} -``` - - - -### ItemSelectedBundleOption - -A list of options of the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String!`](#string) | The label of the option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | -| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | - -#### Example - -```json -{ - "id": 4, - "label": "xyz789", - "uid": 4, - "values": [ItemSelectedBundleOptionValue] -} -``` - - - -### ItemSelectedBundleOptionValue - -A list of values for the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | -| `price` - [`Money!`](#money) | The price of the child bundle product. | -| `product_name` - [`String!`](#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | -| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | - -#### Example - -```json -{ - "id": 4, - "price": Money, - "product_name": "xyz789", - "product_sku": "abc123", - "quantity": 987.65, - "uid": "4" -} -``` - - - -### KeyValue - -Contains a key-value pair. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name part of the key/value pair. | -| `value` - [`String`](#string) | The value part of the key/value pair. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### LayerFilter - -Contains information for rendering layered navigation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | -| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | -| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | -| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | - -#### Example - -```json -{ - "filter_items": [LayerFilterItemInterface], - "filter_items_count": 123, - "name": "xyz789", - "request_var": "xyz789" -} -``` - - - -### LayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 123, - "label": "xyz789", - "value_string": "xyz789" -} -``` - - - -### LayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Possible Types - -| LayerFilterItemInterface Types | -|----------------| -| [`LayerFilterItem`](#layerfilteritem) | -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{ - "items_count": 123, - "label": "abc123", - "value_string": "xyz789" -} -``` - - - -### LineItemNoteInput - -Sets quote item note. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `note` - [`String`](#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "note": "abc123", - "quote_item_uid": "4", - "quote_uid": 4 -} -``` - - - -### MediaGalleryEntry - -Defines characteristics about images and videos associated with a specific product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `file` - [`String`](#string) | The path of the image on the server. | -| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | -| `media_type` - [`String`](#string) | Either `image` or `video`. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | - -#### Example - -```json -{ - "content": ProductMediaGalleryEntriesContent, - "disabled": true, - "file": "abc123", - "id": 987, - "label": "abc123", - "media_type": "abc123", - "position": 987, - "types": ["xyz789"], - "uid": "4", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### MediaGalleryInterface - -Contains basic information about a product image or video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Possible Types - -| MediaGalleryInterface Types | -|----------------| -| [`ProductImage`](#productimage) | -| [`ProductVideo`](#productvideo) | - -#### Example - -```json -{ - "disabled": false, - "label": "xyz789", - "position": 123, - "types": ["xyz789"], - "url": "abc123" -} -``` - - - -### MessageStyleLogo - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | - -#### Example - -```json -{"type": "abc123"} -``` - - - -### MessageStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `layout` - [`String`](#string) | The message layout | -| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | - -#### Example - -```json -{ - "layout": "xyz789", - "logo": MessageStyleLogo -} -``` - - - -### Money - -Defines a monetary value, including a numeric value and a currency code. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](#float) | A number expressing a monetary value. | - -#### Example - -```json -{"currency": "AFN", "value": 987.65} -``` - - - -### MoveCartItemsToGiftRegistryOutput - -Contains the customer's gift registry and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Example - -```json -{ - "gift_registry": GiftRegistry, - "status": false, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### MoveItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be moved. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | - -#### Example - -```json -{"requisitionListItemUids": ["4"]} -``` - - - -### MoveItemsBetweenRequisitionListsOutput - -Output of the request to move items to another requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | - -#### Example - -```json -{ - "destination_requisition_list": RequisitionList, - "source_requisition_list": RequisitionList -} -``` - - - -### MoveLineItemToRequisitionListInput - -Move Line Item to Requisition List. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | - -#### Example - -```json -{ - "quote_item_uid": 4, - "quote_uid": "4", - "requisition_list_uid": 4 -} -``` - - - -### MoveLineItemToRequisitionListOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### MoveProductsBetweenWishlistsOutput - -Contains the source and target wish lists after moving products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | - -#### Example - -```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} -``` - - - -### NegotiableQuote - -Contains details about a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | -| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | -| `email` - [`String`](#string) | The email address of the company user. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | -| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | - -#### Example - -```json -{ - "available_payment_methods": [AvailablePaymentMethod], - "billing_address": NegotiableQuoteBillingAddress, - "buyer": NegotiableQuoteUser, - "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "email": "abc123", - "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, - "items": [CartItemInterface], - "name": "abc123", - "prices": CartPrices, - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "SUBMITTED", - "total_quantity": 123.45, - "uid": "4", - "updated_at": "xyz789" -} -``` - - - -### NegotiableQuoteAddressCountry - -Defines the company's country. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | - -#### Example - -```json -{ - "code": "xyz789", - "label": "xyz789" -} -``` - - - -### NegotiableQuoteAddressInput - -Defines the billing or shipping address to be applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company name. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | - -#### Example - -```json -{ - "city": "xyz789", - "company": "abc123", - "country_code": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "xyz789", - "region": "xyz789", - "region_id": 123, - "save_in_address_book": true, - "street": ["abc123"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteAddressInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Possible Types - -| NegotiableQuoteAddressInterface Types | -|----------------| -| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | -| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | - -#### Example - -```json -{ - "city": "abc123", - "company": "abc123", - "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "abc123", - "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteAddressRegion - -Defines the company's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The address region code. | -| `label` - [`String`](#string) | The display name of the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "code": "abc123", - "label": "abc123", - "region_id": 123 -} -``` - - - -### NegotiableQuoteBillingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | - -#### Example - -```json -{ - "city": "xyz789", - "company": "abc123", - "country": NegotiableQuoteAddressCountry, - "firstname": "xyz789", - "lastname": "xyz789", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], - "telephone": "xyz789" -} -``` - - - -### NegotiableQuoteBillingAddressInput - -Defines the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "same_as_shipping": true, - "use_for_shipping": false -} -``` - - - -### NegotiableQuoteComment - -Contains a single plain text comment from either the buyer or seller. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | -| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](#string) | The plain text comment. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | - -#### Example - -```json -{ - "author": NegotiableQuoteUser, - "created_at": "xyz789", - "creator_type": "BUYER", - "text": "xyz789", - "uid": 4 -} -``` - - - -### NegotiableQuoteCommentCreatorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BUYER` | | -| `SELLER` | | - -#### Example - -```json -""BUYER"" -``` - - - -### NegotiableQuoteCommentInput - -Contains the commend provided by the buyer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The comment provided by the buyer. | - -#### Example - -```json -{"comment": "abc123"} -``` - - - -### NegotiableQuoteCustomLogChange - -Contains custom log entries added by third-party extensions. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_value` - [`String!`](#string) | The new entry content. | -| `old_value` - [`String`](#string) | The previous entry in the custom log. | -| `title` - [`String!`](#string) | The title of the custom log entry. | - -#### Example - -```json -{ - "new_value": "abc123", - "old_value": "abc123", - "title": "abc123" -} -``` - - - -### NegotiableQuoteFilterInput - -Defines a filter to limit the negotiable quotes to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | - -#### Example - -```json -{ - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput -} -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-4.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-4.md deleted file mode 100644 index 6aa44a003..000000000 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-4.md +++ /dev/null @@ -1,2781 +0,0 @@ -### SimpleProduct - -Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "attribute_set_id": 987, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "id": 987, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "abc123", - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 123.45, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "abc123", - "staged": true, - "stock_status": "IN_STOCK", - "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": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website], - "weight": 987.65 -} -``` - - - -### SimpleProductCartItemInput - -Defines a single product to add to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} -``` - - - -### SimpleRequisitionListItem - -Contains details about simple products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 -} -``` - - - -### SimpleWishlistItem - -Contains a simple product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### SmartButtonMethodInput - -Smart button payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "payment_source": "abc123", - "payments_order_id": "abc123", - "paypal_order_id": "abc123" -} -``` - - - -### SmartButtonsConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `app_switch_when_available` - [`Boolean`](#boolean) | Indicated whether to use App Switch on enabled mobile devices | -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "app_switch_when_available": true, - "button_styles": ButtonStyles, - "code": "abc123", - "display_message": false, - "display_venmo": true, - "is_visible": false, - "message_styles": MessageStyles, - "payment_intent": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "abc123" -} -``` - - - -### SortEnum - -Indicates whether to return results in ascending or descending order. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ASC` | | -| `DESC` | | - -#### Example - -```json -""ASC"" -``` - - - -### SortField - -Defines a possible sort field. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String`](#string) | The label of the sort field. | -| `value` - [`String`](#string) | The attribute code of the sort field. | - -#### Example - -```json -{ - "label": "abc123", - "value": "abc123" -} -``` - - - -### SortFields - -Contains a default value for sort fields and all available sort fields. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `default` - [`String`](#string) | The default sort field value. | -| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | - -#### Example - -```json -{ - "default": "abc123", - "options": [SortField] -} -``` - - - -### SortQuoteItemsEnum - -Specifies the field to use for sorting quote items - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""ITEM_ID"" -``` - - - -### StoreConfig - -Contains information about a store's configuration. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `<body>` tag. | -| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | -| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | -| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | -| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | -| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | -| `base_currency_code` - [`String`](#string) | The base currency code. | -| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | -| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | -| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | -| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | -| `braintree_3dsecure_allowspecific` - [`Boolean`](#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | -| `braintree_3dsecure_always_request_3ds` - [`Boolean`](#boolean) | Braintree 3D Secure, always request 3D Secure flag. | -| `braintree_3dsecure_specificcountry` - [`String`](#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`](#string) | Braintree 3D Secure, threshold above which 3D Secure should be requested. | -| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](#boolean) | Braintree 3D Secure enabled/active status. | -| `braintree_ach_direct_debit_vault_active` - [`Boolean`](#boolean) | Braintree ACH vault status. | -| `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | -| `braintree_applepay_vault_active` - [`Boolean`](#boolean) | Braintree Apple Pay vault status. | -| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | -| `braintree_cc_vault_cvv` - [`Boolean`](#boolean) | Braintree cc vault CVV re-verification enabled status. | -| `braintree_environment` - [`String`](#string) | Braintree environment. | -| `braintree_googlepay_btn_color` - [`String`](#string) | Braintree Google Pay button color. | -| `braintree_googlepay_cctypes` - [`String`](#string) | Braintree Google Pay Card types supported. | -| `braintree_googlepay_merchant_id` - [`String`](#string) | Braintree Google Pay merchant ID. | -| `braintree_googlepay_vault_active` - [`Boolean`](#boolean) | Braintree Google Pay vault status. | -| `braintree_local_payment_allowed_methods` - [`String`](#string) | Braintree Local Payment Methods allowed payment methods. | -| `braintree_local_payment_fallback_button_text` - [`String`](#string) | Braintree Local Payment Methods fallback button text. | -| `braintree_local_payment_redirect_on_fail` - [`String`](#string) | Braintree Local Payment Methods redirect URL on failed payment. | -| `braintree_merchant_account_id` - [`String`](#string) | Braintree Merchant Account ID. | -| `braintree_paypal_button_location_cart_type_credit_color` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_credit_label` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | -| `braintree_paypal_button_location_cart_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style layout. | -| `braintree_paypal_button_location_cart_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo. | -| `braintree_paypal_button_location_cart_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo position. | -| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | -| `braintree_paypal_button_location_cart_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | -| `braintree_paypal_button_location_cart_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | -| `braintree_paypal_button_location_cart_type_paypal_color` - [`String`](#string) | Braintree PayPal mini-cart & cart button style color. | -| `braintree_paypal_button_location_cart_type_paypal_label` - [`String`](#string) | Braintree PayPal mini-cart & cart button style label. | -| `braintree_paypal_button_location_cart_type_paypal_shape` - [`String`](#string) | Braintree PayPal mini-cart & cart button style shape. | -| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal mini-cart & cart button show. | -| `braintree_paypal_button_location_checkout_type_credit_color` - [`String`](#string) | Braintree PayPal Credit checkout button style color. | -| `braintree_paypal_button_location_checkout_type_credit_label` - [`String`](#string) | Braintree PayPal Credit checkout button style label. | -| `braintree_paypal_button_location_checkout_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit checkout button show status. | -| `braintree_paypal_button_location_checkout_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style layout. | -| `braintree_paypal_button_location_checkout_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo. | -| `braintree_paypal_button_location_checkout_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo position. | -| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging checkout show status. | -| `braintree_paypal_button_location_checkout_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | -| `braintree_paypal_button_location_checkout_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later checkout button style color. | -| `braintree_paypal_button_location_checkout_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later checkout button style label. | -| `braintree_paypal_button_location_checkout_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later checkout button show status. | -| `braintree_paypal_button_location_checkout_type_paypal_color` - [`String`](#string) | Braintree PayPal checkout button style color. | -| `braintree_paypal_button_location_checkout_type_paypal_label` - [`String`](#string) | Braintree PayPal checkout button style label. | -| `braintree_paypal_button_location_checkout_type_paypal_shape` - [`String`](#string) | Braintree PayPal checkout button style shape. | -| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal checkout button show. | -| `braintree_paypal_button_location_productpage_type_credit_color` - [`String`](#string) | Braintree PayPal Credit PDP button style color. | -| `braintree_paypal_button_location_productpage_type_credit_label` - [`String`](#string) | Braintree PayPal Credit PDP button style label. | -| `braintree_paypal_button_location_productpage_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit PDP button show status. | -| `braintree_paypal_button_location_productpage_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style layout. | -| `braintree_paypal_button_location_productpage_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo. | -| `braintree_paypal_button_location_productpage_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo position. | -| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging PDP show status. | -| `braintree_paypal_button_location_productpage_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style text color. | -| `braintree_paypal_button_location_productpage_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later PDP button style color. | -| `braintree_paypal_button_location_productpage_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later PDP button style label. | -| `braintree_paypal_button_location_productpage_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later PDP button show status. | -| `braintree_paypal_button_location_productpage_type_paypal_color` - [`String`](#string) | Braintree PayPal PDP button style color. | -| `braintree_paypal_button_location_productpage_type_paypal_label` - [`String`](#string) | Braintree PayPal PDP button style label. | -| `braintree_paypal_button_location_productpage_type_paypal_shape` - [`String`](#string) | Braintree PayPal PDP button style shape. | -| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal PDP button show. | -| `braintree_paypal_credit_uk_merchant_name` - [`String`](#string) | Braintree PayPal Credit Merchant Name on the FCA Register. | -| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](#boolean) | Should display Braintree PayPal in mini-cart & cart? | -| `braintree_paypal_merchant_country` - [`String`](#string) | Braintree PayPal merchant's country. | -| `braintree_paypal_merchant_name_override` - [`String`](#string) | Braintree PayPal override for Merchant Name. | -| `braintree_paypal_require_billing_address` - [`Boolean`](#boolean) | Does Braintree PayPal require the customer's billing address? | -| `braintree_paypal_send_cart_line_items` - [`Boolean`](#boolean) | Does Braintree PayPal require the order line items? | -| `braintree_paypal_vault_active` - [`Boolean`](#boolean) | Braintree PayPal vault status. | -| `cart_expires_in_days` - [`Int`](#int) | checkout/cart/delete_quote_after: quote lifetime in days. | -| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | -| `cart_merge_preference` - [`String!`](#string) | Configuration data from checkout/cart/cart_merge_preference | -| `cart_printed_card` - [`String`](#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`](#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`](#string) | The default sort order of the search results list. | -| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | -| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | -| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | -| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | -| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | -| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | -| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | -| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | -| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | -| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | -| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | -| `configurable_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | -| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | -| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | -| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | -| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | -| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | -| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | -| `default_description` - [`String`](#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`](#string) | The default display currency code. | -| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | -| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | -| `demonotice` - [`Int`](#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!`](#int) | Configuration data from tax/display/type | -| `display_shipping_prices` - [`Int!`](#int) | Configuration data from tax/display/shipping | -| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | -| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | -| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](#boolean) | Configuration data from tax/weee/apply_vat | -| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](#int) | Configuration data from tax/weee/display_email | -| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](#int) | Configuration data from tax/weee/display_list | -| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](#int) | Configuration data from tax/weee/display_sales | -| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](#int) | Configuration data from tax/weee/display | -| `fixed_product_taxes_enable` - [`Boolean!`](#boolean) | Configuration data from tax/weee/enable | -| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](#boolean) | Configuration data from tax/weee/include_in_subtotal | -| `front` - [`String`](#string) | The landing page that is associated with the base URL. | -| `graphql_share_customer_group` - [`Boolean`](#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | -| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | -| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | -| `grouped_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | -| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `<head>` tag. | -| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | -| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | -| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | -| `is_checkout_agreements_enabled` - [`Boolean!`](#boolean) | Configuration data from checkout/options/enable_agreements | -| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | -| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | -| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | -| `list_mode` - [`String`](#string) | The format of the search results list. | -| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | -| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | -| `locale` - [`String`](#string) | The store locale. | -| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | -| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | -| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | -| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | -| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | -| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | -| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | -| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | -| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | -| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | -| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | -| `max_items_in_order_summary` - [`Int`](#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | -| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | -| `minicart_display` - [`Boolean`](#boolean) | checkout/sidebar/display: whether to display the minicart or not. | -| `minicart_max_items` - [`Int`](#int) | checkout/sidebar/count: maximum number of items to show in minicart. | -| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | -| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | -| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | -| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | -| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | -| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/full_summary | -| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/grandtotal | -| `orders_invoices_credit_memos_display_price` - [`Int!`](#int) | Configuration data from tax/sales_display/price | -| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](#int) | Configuration data from tax/sales_display/shipping | -| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](#int) | Configuration data from tax/sales_display/subtotal | -| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/zero_tax | -| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | -| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. *(Deprecated: Use printed_card_priceV2 instead)* | -| `printed_card_priceV2` - [`Money`](#money) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | -| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | -| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | -| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | -| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | -| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | -| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | -| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | -| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | -| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | -| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | -| `share_active_segments` - [`Boolean`](#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | -| `share_applied_cart_rule` - [`Boolean`](#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | -| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | -| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | -| `store_group_name` - [`String`](#string) | The label assigned to the store group. | -| `store_name` - [`String`](#string) | The label assigned to the store view. | -| `store_sort_order` - [`Int`](#int) | The store view sort order. | -| `timezone` - [`String`](#string) | The time zone of the store. | -| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | -| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | -| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | -| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](#id) | The unique ID for the website. | -| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | -| `website_name` - [`String`](#string) | The label assigned to the website. | -| `weight_unit` - [`String`](#string) | The unit of weight. | -| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | -| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | -| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | -| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | - -#### Example - -```json -{ - "absolute_footer": "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_items": "abc123", - "allow_order": "xyz789", - "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": "abc123", - "braintree_3dsecure_allowspecific": false, - "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": true, - "braintree_applepay_merchant_name": "abc123", - "braintree_applepay_vault_active": false, - "braintree_cc_vault_active": "abc123", - "braintree_cc_vault_cvv": true, - "braintree_environment": "abc123", - "braintree_googlepay_btn_color": "xyz789", - "braintree_googlepay_cctypes": "xyz789", - "braintree_googlepay_merchant_id": "xyz789", - "braintree_googlepay_vault_active": true, - "braintree_local_payment_allowed_methods": "abc123", - "braintree_local_payment_fallback_button_text": "xyz789", - "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": "xyz789", - "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": "xyz789", - "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": false, - "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_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": true, - "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": "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": "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": "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": "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": "abc123", - "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": "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": 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": "abc123", - "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": "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": "abc123", - "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": "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": "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": "abc123", - "check_money_order_sort_order": 987, - "check_money_order_title": "xyz789", - "cms_home_page": "xyz789", - "cms_no_cookies": "xyz789", - "cms_no_route": "xyz789", - "code": "abc123", - "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, - "copyright": "xyz789", - "countries_with_required_region": "abc123", - "create_account_confirmation": true, - "customer_access_token_lifetime": 123.45, - "default_country": "abc123", - "default_description": "xyz789", - "default_display_currency_code": "xyz789", - "default_keywords": "xyz789", - "default_title": "abc123", - "demonotice": 123, - "display_product_prices_in_catalog": 987, - "display_shipping_prices": 987, - "display_state_if_optional": true, - "enable_multiple_wishlists": "abc123", - "fixed_product_taxes_apply_tax_to_fpt": true, - "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": 987, - "fixed_product_taxes_enable": true, - "fixed_product_taxes_include_fpt_in_subtotal": false, - "front": "abc123", - "graphql_share_customer_group": true, - "grid_per_page": 987, - "grid_per_page_values": "xyz789", - "grouped_product_image": "ITSELF", - "head_includes": "xyz789", - "head_shortcut_icon": "xyz789", - "header_logo_src": "xyz789", - "id": 123, - "is_checkout_agreements_enabled": true, - "is_default_store": true, - "is_default_store_group": false, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": false, - "is_requisition_list_active": "abc123", - "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "xyz789", - "locale": "abc123", - "logo_alt": "abc123", - "logo_height": 123, - "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": "xyz789", - "magento_reward_points_invitation_order": "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_review": "abc123", - "magento_reward_points_review_limit": "abc123", - "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": "abc123", - "newsletter_enabled": false, - "no_route": "abc123", - "optional_zip_countries": "xyz789", - "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": 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": "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": "xyz789", - "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": "xyz789", - "secure_base_url": "abc123", - "send_friend": SendFriendConfiguration, - "share_active_segments": true, - "share_applied_cart_rule": false, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": true, - "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, - "show_cms_breadcrumbs": 123, - "store_code": "4", - "store_group_code": "4", - "store_group_name": "abc123", - "store_name": "abc123", - "store_sort_order": 123, - "timezone": "xyz789", - "title_prefix": "xyz789", - "title_separator": "xyz789", - "title_suffix": "xyz789", - "use_store_in_url": false, - "website_code": 4, - "website_id": 123, - "website_name": "abc123", - "weight_unit": "xyz789", - "welcome": "abc123", - "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": false, - "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" -} -``` - - - -### StorefrontProperties - -Indicates where an attribute can be displayed. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | -| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | -| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | -| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | -| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | - -#### Example - -```json -{ - "position": 987, - "use_in_layered_navigation": "NO", - "use_in_product_listing": false, - "use_in_search_results_layered_navigation": false, - "visible_on_catalog_pages": false -} -``` - - - -### String - -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 - -```json -"xyz789" -``` - - - -### SubmitNegotiableQuoteTemplateForReviewInput - -Specifies the quote template properties to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | -| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "comment": "xyz789", - "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "abc123", - "reference_document_links": [ - NegotiableQuoteTemplateReferenceDocumentLinkInput - ], - "template_id": "4" -} -``` - - - -### SubscribeEmailToNewsletterOutput - -Contains the result of the `subscribeEmailToNewsletter` operation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | - -#### Example - -```json -{"status": "NOT_ACTIVE"} -``` - - - -### SubscriptionStatusesEnum - -Indicates the status of the request. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_ACTIVE` | | -| `SUBSCRIBED` | | -| `UNSUBSCRIBED` | | -| `UNCONFIRMED` | | - -#### Example - -```json -""NOT_ACTIVE"" -``` - - - -### SwatchData - -Describes the swatch type and a value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | -| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | - -#### Example - -```json -{ - "type": "xyz789", - "value": "xyz789" -} -``` - - - -### SwatchDataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Possible Types - -| SwatchDataInterface Types | -|----------------| -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | -| [`ColorSwatchData`](#colorswatchdata) | - -#### Example - -```json -{"value": "xyz789"} -``` - - - -### SwatchInputTypeEnum - -Swatch attribute metadata input types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `DROPDOWN` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `UNDEFINED` | | -| `VISUAL` | | -| `WEIGHT` | | - -#### Example - -```json -""BOOLEAN"" -``` - - - -### SwatchLayerFilterItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | -| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | -| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | - -#### Example - -```json -{ - "items_count": 987, - "label": "xyz789", - "swatch_data": SwatchData, - "value_string": "xyz789" -} -``` - - - -### SwatchLayerFilterItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | - -#### Possible Types - -| SwatchLayerFilterItemInterface Types | -|----------------| -| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | - -#### Example - -```json -{"swatch_data": SwatchData} -``` - - - -### SyncPaymentOrderInput - -Synchronizes the payment order details - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cartId": "abc123", - "id": "xyz789" -} -``` - - - -### TaxItem - -Contains tax item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | -| `title` - [`String!`](#string) | A title that describes the tax. | - -#### Example - -```json -{ - "amount": Money, - "rate": 123.45, - "title": "xyz789" -} -``` - - - -### TaxWrappingEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `DISPLAY_EXCLUDING_TAX` | | -| `DISPLAY_INCLUDING_TAX` | | -| `DISPLAY_TYPE_BOTH` | | - -#### Example - -```json -""DISPLAY_EXCLUDING_TAX"" -``` - - - -### TextSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{"value": "xyz789"} -``` - - - -### ThreeDSMode - -3D Secure mode. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `OFF` | | -| `SCA_WHEN_REQUIRED` | | -| `SCA_ALWAYS` | | - -#### Example - -```json -""OFF"" -``` - - - -### TierPrice - -Defines a price based on the quantity purchased. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | -| `final_price` - [`Money`](#money) | The price of the product at this tier. | -| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "quantity": 123.45 -} -``` - - - -### UpdateCartItemsInput - -Modifies the specified items in the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | - -#### Example - -```json -{ - "cart_id": "abc123", - "cart_items": [CartItemUpdateInput] -} -``` - - - -### UpdateCartItemsOutput - -Contains details about the cart after updating items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after updating products. | -| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | - -#### Example - -```json -{ - "cart": Cart, - "errors": [CartUserInputError] -} -``` - - - -### UpdateCompanyOutput - -Contains the response to the request to update the company. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | - -#### Example - -```json -{"company": Company} -``` - - - -### UpdateCompanyRoleOutput - -Contains the response to the request to update the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | - -#### Example - -```json -{"role": CompanyRole} -``` - - - -### UpdateCompanyStructureOutput - -Contains the response to the request to update the company structure. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company!`](#company) | The updated company instance. | - -#### Example - -```json -{"company": Company} -``` - - - -### UpdateCompanyTeamOutput - -Contains the response to the request to update a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | - -#### Example - -```json -{"team": CompanyTeam} -``` - - - -### UpdateCompanyUserOutput - -Contains the response to the request to update the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user` - [`Customer!`](#customer) | The updated company user instance. | - -#### Example - -```json -{"user": Customer} -``` - - - -### UpdateGiftRegistryInput - -Defines updates to a `GiftRegistry` object. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | -| `event_name` - [`String`](#string) | The updated name of the event. | -| `message` - [`String`](#string) | The updated message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "xyz789", - "message": "abc123", - "privacy_settings": "PRIVATE", - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" -} -``` - - - -### UpdateGiftRegistryItemInput - -Defines updates to an item in a gift registry. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | -| `note` - [`String`](#string) | The updated description of the item. | -| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | - -#### Example - -```json -{ - "gift_registry_item_uid": "4", - "note": "abc123", - "quantity": 123.45 -} -``` - - - -### UpdateGiftRegistryItemsOutput - -Contains the results of a request to update gift registry items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateGiftRegistryOutput - -Contains the results of a request to update a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateGiftRegistryRegistrantInput - -Defines updates to an existing registrant. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | -| `firstname` - [`String`](#string) | The updated first name of the registrant. | -| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | -| `lastname` - [`String`](#string) | The updated last name of the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "abc123", - "firstname": "abc123", - "gift_registry_registrant_uid": 4, - "lastname": "abc123" -} -``` - - - -### UpdateGiftRegistryRegistrantsOutput - -Contains the results a request to update registrants. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### UpdateNegotiableQuoteItemsQuantityOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### UpdateNegotiableQuoteQuantitiesInput - -Specifies the items to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": "4" -} -``` - - - -### UpdateNegotiableQuoteTemplateItemsQuantityOutput - -Contains the updated negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | - -#### Example - -```json -{"quote_template": NegotiableQuoteTemplate} -``` - - - -### UpdateNegotiableQuoteTemplateQuantitiesInput - -Specifies the items to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "items": [NegotiableQuoteTemplateItemQuantityInput], - "template_id": "4" -} -``` - - - -### UpdateProductsInWishlistOutput - -Contains the customer's wish list and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | - -#### Example - -```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} -``` - - - -### UpdatePurchaseOrderApprovalRuleInput - -Defines the changes to be made to an approval rule. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | -| `description` - [`String`](#string) | The updated approval rule description. | -| `name` - [`String`](#string) | The updated approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | - -#### Example - -```json -{ - "applies_to": [4], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", - "name": "abc123", - "status": "ENABLED", - "uid": 4 -} -``` - - - -### UpdateRequisitionListInput - -An input object that defines which requistion list characteristics to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | The updated description of the requisition list. | -| `name` - [`String!`](#string) | The new name of the requisition list. | - -#### Example - -```json -{ - "description": "xyz789", - "name": "xyz789" -} -``` - - - -### UpdateRequisitionListItemsInput - -Defines which items in a requisition list to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | -| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | -| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "item_id": 4, - "quantity": 987.65, - "selected_options": ["xyz789"] -} -``` - - - -### UpdateRequisitionListItemsOutput - -Output of the request to update items in the specified requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateRequisitionListOutput - -Output of the request to rename the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### UpdateWishlistOutput - -Contains the name and visibility of an updated wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The wish list name. | -| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | - -#### Example - -```json -{ - "name": "xyz789", - "uid": 4, - "visibility": "PUBLIC" -} -``` - - - -### UrlRewrite - -Contains URL rewrite details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | -| `url` - [`String`](#string) | The request URL. | - -#### Example - -```json -{ - "parameters": [HttpQueryParameter], - "url": "abc123" -} -``` - - - -### UrlRewriteEntityTypeEnum - -This enumeration defines the entity type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CMS_PAGE` | | -| `PRODUCT` | | -| `CATEGORY` | | - -#### Example - -```json -""CMS_PAGE"" -``` - - - -### UseInLayeredNavigationOptions - -Defines whether the attribute is filterable in layered navigation. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NO` | | -| `FILTERABLE_WITH_RESULTS` | | -| `FILTERABLE_NO_RESULT` | | - -#### Example - -```json -""NO"" -``` - - - -### UserCompaniesInput - -Defines the input for returning matching companies the customer is assigned to. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. | -| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. This attribute is optional. | -| `sort` - [`[CompaniesSortInput]`](#companiessortinput) | Defines the sorting of the results. | - -#### Example - -```json -{ - "currentPage": 987, - "pageSize": 123, - "sort": [CompaniesSortInput] -} -``` - - - -### UserCompaniesOutput - -An object that contains a list of companies customer is assigned to. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | - -#### Example - -```json -{ - "items": [CompanyBasicInfo], - "page_info": SearchResultPageInfo -} -``` - - - -### ValidatePurchaseOrderError - -Contains details about a failed validation attempt. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | - -#### Example - -```json -{"message": "abc123", "type": "NOT_FOUND"} -``` - - - -### ValidatePurchaseOrderErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | - -#### Example - -```json -""NOT_FOUND"" -``` - - - -### ValidatePurchaseOrdersInput - -Defines the purchase orders to be validated. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | - -#### Example - -```json -{"purchase_order_uids": ["4"]} -``` - - - -### ValidatePurchaseOrdersOutput - -Contains the results of validation attempts. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | - -#### Example - -```json -{ - "errors": [ValidatePurchaseOrderError], - "purchase_orders": [PurchaseOrder] -} -``` - - - -### ValidationRule - -Defines a customer attribute validation rule. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | -| `value` - [`String`](#string) | Validation rule value. | - -#### Example - -```json -{ - "name": "DATE_RANGE_MAX", - "value": "abc123" -} -``` - - - -### ValidationRuleEnum - -List of validation rule names applied to a customer attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""DATE_RANGE_MAX"" -``` - - - -### VaultConfigOutput - -Retrieves the vault configuration - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `credit_card` - [`VaultCreditCardConfig`](#vaultcreditcardconfig) | Credit card vault method configuration | - -#### Example - -```json -{"credit_card": VaultCreditCardConfig} -``` - - - -### VaultCreditCardConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | - -#### Example - -```json -{ - "is_vault_enabled": true, - "sdk_params": [SDKParams], - "three_ds_mode": "OFF" -} -``` - - - -### VaultMethodInput - -Vault payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | -| `public_hash` - [`String`](#string) | The public hash of the token. | - -#### Example - -```json -{ - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123", - "public_hash": "xyz789" -} -``` - - - -### VaultSetupTokenInput - -The payment source information - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | - -#### Example - -```json -{"payment_source": PaymentSourceInput} -``` - - - -### VaultTokenInput - -Contains required input for payment methods with Vault support. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `public_hash` - [`String!`](#string) | The public hash of the payment token. | - -#### Example - -```json -{"public_hash": "abc123"} -``` - - - -### VirtualCartItem - -An implementation for virtual product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "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 -} -``` - - - -### VirtualProduct - -Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "attribute_set_id": 987, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "abc123", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "rating_summary": 123.45, - "redirect_code": 987, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 123, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_from_date": "xyz789", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": false, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "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": "xyz789", - "url_path": "abc123", - "url_rewrites": [UrlRewrite], - "url_suffix": "abc123", - "websites": [Website] -} -``` - - - -### VirtualProductCartItemInput - -Defines a single product to add to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput -} -``` - - - -### VirtualRequisitionListItem - -Contains details about virtual products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 -} -``` - - - -### VirtualWishlistItem - -Contains a virtual product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### Website - -Deprecated. It should not be used on the storefront. Contains information about a website. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | -| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | -| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | -| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | -| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | - -#### Example - -```json -{ - "code": "abc123", - "default_group_id": "abc123", - "id": 987, - "is_default": false, - "name": "abc123", - "sort_order": 123 -} -``` - - - -### WishListUserInputError - -An error encountered while performing operations with WishList. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" -} -``` - - - -### WishListUserInputErrorType - -A list of possible error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `UNDEFINED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### Wishlist - -Contains a customer wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | -| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. | -| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | -| `name` - [`String`](#string) | The name of the wish list. | -| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | - -#### Example - -```json -{ - "id": "4", - "items": [WishlistItem], - "items_count": 987, - "items_v2": WishlistItems, - "name": "xyz789", - "sharing_code": "abc123", - "updated_at": "xyz789", - "visibility": "PUBLIC" -} -``` - - - -### WishlistCartUserInputError - -Contains details about errors encountered when a customer added wish list items to the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | -| `message` - [`String!`](#string) | A localized error message. | -| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | -| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "wishlistId": "4", - "wishlistItemId": "4" -} -``` - - - -### WishlistCartUserInputErrorType - -A list of possible error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `REQUIRED_PARAMETER_MISSING` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### WishlistItem - -Contains details about a wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | -| `description` - [`String`](#string) | The customer's comment about this item. | -| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | -| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | -| `qty` - [`Float`](#float) | The quantity of this wish list item | - -#### Example - -```json -{ - "added_at": "xyz789", - "description": "xyz789", - "id": 123, - "product": ProductInterface, - "qty": 987.65 -} -``` - - - -### WishlistItemCopyInput - -Specifies the IDs of items to copy and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | - -#### Example - -```json -{"quantity": 123.45, "wishlist_item_id": 4} -``` - - - -### WishlistItemInput - -Defines the items to add to a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of items to add. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 123.45, - "selected_options": [4], - "sku": "xyz789" -} -``` - - - -### WishlistItemInterface - -The interface for wish list items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Possible Types - -| WishlistItemInterface Types | -|----------------| -| [`SimpleWishlistItem`](#simplewishlistitem) | -| [`VirtualWishlistItem`](#virtualwishlistitem) | -| [`ConfigurableWishlistItem`](#configurablewishlistitem) | -| [`DownloadableWishlistItem`](#downloadablewishlistitem) | -| [`BundleWishlistItem`](#bundlewishlistitem) | -| [`GiftCardWishlistItem`](#giftcardwishlistitem) | -| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | - -#### Example - -```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 -} -``` - - - -### WishlistItemMoveInput - -Specifies the IDs of the items to move and their quantities. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | - -#### Example - -```json -{"quantity": 987.65, "wishlist_item_id": 4} -``` - - - -### WishlistItemUpdateInput - -Defines updates to items in a wish list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | Customer-entered comments about the item. | -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | -| `quantity` - [`Float`](#float) | The new amount or number of this item. | -| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | -| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | - -#### Example - -```json -{ - "description": "xyz789", - "entered_options": [EnteredOptionInput], - "quantity": 987.65, - "selected_options": ["4"], - "wishlist_item_id": "4" -} -``` - - - -### WishlistItems - -Contains an array of items in a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | - -#### Example - -```json -{ - "items": [WishlistItemInterface], - "page_info": SearchResultPageInfo -} -``` - - - -### WishlistOutput - -Deprecated: Use the `Wishlist` type instead. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | -| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | -| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | -| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | -| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | - -#### Example - -```json -{ - "items": [WishlistItem], - "items_count": 123, - "name": "xyz789", - "sharing_code": "xyz789", - "updated_at": "xyz789" -} -``` - - - -### WishlistVisibilityEnum - -Defines the wish list visibility types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PUBLIC` | | -| `PRIVATE` | | - -#### Example - -```json -""PUBLIC"" -``` - - - -### createEmptyCartInput - -Assigns a specific `cart_id` to the empty cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String`](#string) | The ID to assign to the cart. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-a-b.md new file mode 100644 index 000000000..8eded2434 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-a-b.md @@ -0,0 +1,2464 @@ +## Types + +### AcceptNegotiableQuoteTemplateInput + +Specifies the quote template id to accept quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": 4} +``` + + + +### AddBundleProductsToCartInput + +Defines the bundle products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [BundleProductCartItemInput] +} +``` + + + +### AddBundleProductsToCartOutput + +Contains details about the cart after adding bundle products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddConfigurableProductsToCartInput + +Defines the configurable products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [ConfigurableProductCartItemInput] +} +``` + + + +### AddConfigurableProductsToCartOutput + +Contains details about the cart after adding configurable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddDownloadableProductsToCartInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [DownloadableProductCartItemInput] +} +``` + + + +### AddDownloadableProductsToCartOutput + +Contains details about the cart after adding downloadable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddGiftRegistryRegistrantInput + +Defines a new registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](#string) | The email address of the registrant. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "abc123", + "lastname": "abc123" +} +``` + + + +### AddGiftRegistryRegistrantsOutput + +Contains the results of a request to add registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### AddProductsToCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](#error) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [Error] +} +``` + + + +### AddProductsToCompareListInput + +Contains products to add to an existing compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{ + "products": ["4"], + "uid": "4" +} +``` + + + +### AddProductsToNewCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [CartUserInputError] +} +``` + + + +### AddProductsToRequisitionListOutput + +Output of the request to add products to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### AddProductsToWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### AddPurchaseOrderCommentInput + +Contains the comment to be added to a purchase order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | + +#### Example + +```json +{ + "comment": "xyz789", + "purchase_order_uid": 4 +} +``` + + + +### AddPurchaseOrderCommentOutput + +Contains the successfully added comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | + +#### Example + +```json +{"comment": PurchaseOrderComment} +``` + + + +### AddPurchaseOrderItemsToCartInput + +Defines the purchase order and cart to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "purchase_order_uid": "4", + "replace_existing_cart_items": false +} +``` + + + +### AddRequisitionListItemToCartUserError + +Contains details about why an attempt to add items to the requistion list failed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | A description of the error. | +| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | + +#### Example + +```json +{ + "message": "abc123", + "type": "OUT_OF_STOCK" +} +``` + + + +### AddRequisitionListItemToCartUserErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OUT_OF_STOCK` | | +| `UNAVAILABLE_SKU` | | +| `OPTIONS_UPDATED` | | +| `LOW_QUANTITY` | | + +#### Example + +```json +""OUT_OF_STOCK"" +``` + + + +### AddRequisitionListItemsToCartOutput + +Output of the request to add items in a requisition list to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | +| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | + +#### Example + +```json +{ + "add_requisition_list_items_to_cart_user_errors": [ + AddRequisitionListItemToCartUserError + ], + "cart": Cart, + "status": false +} +``` + + + +### AddReturnCommentInput + +Defines a return comment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String!`](#string) | The text added to the return request. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "comment_text": "abc123", + "return_uid": "4" +} +``` + + + +### AddReturnCommentOutput + +Contains details about the return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | The modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### AddReturnTrackingInput + +Defines tracking information to be added to the return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | + +#### Example + +```json +{ + "carrier_uid": 4, + "return_uid": 4, + "tracking_number": "xyz789" +} +``` + + + +### AddReturnTrackingOutput + +Contains the response after adding tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | + +#### Example + +```json +{ + "return": Return, + "return_shipping_tracking": ReturnShippingTracking +} +``` + + + +### AddSimpleProductsToCartInput + +Defines the simple and group products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [SimpleProductCartItemInput] +} +``` + + + +### AddSimpleProductsToCartOutput + +Contains details about the cart after adding simple or group products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddVirtualProductsToCartInput + +Defines the virtual products to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "cart_items": [VirtualProductCartItemInput] +} +``` + + + +### AddVirtualProductsToCartOutput + +Contains details about the cart after adding virtual products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddWishlistItemsToCartOutput + +Contains the resultant wish list and any error information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "add_wishlist_items_to_cart_user_errors": [ + WishlistCartUserInputError + ], + "status": true, + "wishlist": Wishlist +} +``` + + + +### Aggregation + +Contains information for each filterable option (such as price, category `UID`, and custom attributes). + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | +| `count` - [`Int`](#int) | The number of options in the aggregation group. | +| `label` - [`String`](#string) | The aggregation display name. | +| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | +| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "count": 123, + "label": "xyz789", + "options": [AggregationOption], + "position": 123 +} +``` + + + +### AggregationOption + +An implementation of `AggregationOptionInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Example + +```json +{ + "count": 123, + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AggregationOptionInterface + +Defines aggregation option fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int`](#int) | The number of items that match the aggregation option. | +| `label` - [`String`](#string) | The display label for an aggregation option. | +| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | + +#### Possible Types + +| AggregationOptionInterface Types | +|----------------| +| [`AggregationOption`](#aggregationoption) | + +#### Example + +```json +{ + "count": 987, + "label": "abc123", + "value": "abc123" +} +``` + + + +### AggregationsCategoryFilterInput + +Filter category aggregations in layered navigation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | + +#### Example + +```json +{"includeDirectChildrenOnly": false} +``` + + + +### AggregationsFilterInput + +An input object that specifies the filters used in product aggregations. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | + +#### Example + +```json +{"category": AggregationsCategoryFilterInput} +``` + + + +### ApplePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": ButtonStyles, + "code": "abc123", + "is_visible": true, + "payment_intent": "abc123", + "payment_source": "xyz789", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "title": "abc123" +} +``` + + + +### ApplePayMethodInput + +Apple Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "abc123", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### AppliedCoupon + +Contains the applied coupon code. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | + +#### Example + +```json +{"code": "abc123"} +``` + + + +### AppliedGiftCard + +Contains an applied gift card with applied and remaining balance. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | +| `code` - [`String`](#string) | The gift card account code. | +| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "xyz789", + "current_balance": Money, + "expiration_date": "abc123" +} +``` + + + +### AppliedStoreCredit + +Contains the applied and current balances. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | + +#### Example + +```json +{ + "applied_balance": Money, + "current_balance": Money, + "enabled": true +} +``` + + + +### ApplyCouponToCartInput + +Specifies the coupon code to apply to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](#string) | A valid coupon code. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "coupon_code": "abc123" +} +``` + + + +### ApplyCouponToCartOutput + +Contains details about the cart after applying a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyCouponsStrategy + +The strategy to apply coupons to the cart. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""APPEND"" +``` + + + +### ApplyCouponsToCartInput + +Apply coupons to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | + +#### Example + +```json +{ + "cart_id": "abc123", + "coupon_codes": ["xyz789"], + "type": "APPEND" +} +``` + + + +### ApplyGiftCardToCartInput + +Defines the input required to run the `applyGiftCardToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_card_code": "abc123" +} +``` + + + +### ApplyGiftCardToCartOutput + +Defines the possible output for the `applyGiftCardToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyGiftCardToOrder + +Contains applied gift cards with gift card code and amount. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](#string) | The gift card account code. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "xyz789" +} +``` + + + +### ApplyRewardPointsToCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyStoreCreditToCartInput + +Defines the input required to run the `applyStoreCreditToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### ApplyStoreCreditToCartOutput + +Defines the possible output for the `applyStoreCreditToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AreaInput + +AreaInput defines the parameters which will be used for filter by specified location. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `radius` - [`Int!`](#int) | The radius for the search in KM. | +| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | + +#### Example + +```json +{"radius": 123, "search_term": "abc123"} +``` + + + +### AssignCompareListToCustomerOutput + +Contains the results of the request to assign a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | + +#### Example + +```json +{"compare_list": CompareList, "result": false} +``` + + + +### Attribute + +Contains details about the attribute, including the code and type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | +| `attribute_type` - [`String`](#string) | The data type of the attribute. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| `input_type` - [`String`](#string) | The frontend input type of the attribute. | +| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "attribute_options": [AttributeOption], + "attribute_type": "abc123", + "entity_type": "xyz789", + "input_type": "abc123", + "storefront_properties": StorefrontProperties +} +``` + + + +### AttributeEntityTypeEnum + +List of all entity types. Populated by the modules introducing EAV entities. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CATALOG_PRODUCT` | | +| `CATALOG_CATEGORY` | | +| `CUSTOMER` | | +| `CUSTOMER_ADDRESS` | | +| `RMA_ITEM` | | + +#### Example + +```json +""CATALOG_PRODUCT"" +``` + + + +### AttributeFilterInput + +An input object that specifies the filters used for attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | + +#### Example + +```json +{ + "is_comparable": true, + "is_filterable": true, + "is_filterable_in_search": true, + "is_html_allowed_on_front": true, + "is_searchable": true, + "is_used_for_customer_segment": 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": true, + "used_in_product_listing": false +} +``` + + + +### AttributeFrontendInputEnum + +EAV attribute frontend input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `WEIGHT` | | +| `UNDEFINED` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### AttributeInput + +Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "entity_type": "abc123" +} +``` + + + +### AttributeInputSelectedOption + +Specifies selected option for a select or multiselect attribute value. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### AttributeMetadata + +Base EAV implementation of CustomAttributeMetadataInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | + +#### Example + +```json +{ + "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] +} +``` + + + +### AttributeMetadataError + +Attribute metadata retrieval error. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | + +#### Example + +```json +{ + "message": "xyz789", + "type": "ENTITY_NOT_FOUND" +} +``` + + + +### AttributeMetadataErrorType + +Attribute metadata retrieval error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ENTITY_NOT_FOUND"" +``` + + + +### AttributeOption + +Defines an attribute option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label assigned to the attribute option. | +| `value` - [`String`](#string) | The attribute option value. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "abc123" +} +``` + + + +### AttributeOptionMetadata + +Base EAV implementation of CustomAttributeOptionInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{ + "is_default": false, + "label": "xyz789", + "value": "abc123" +} +``` + + + +### AttributeSelectedOption + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOptionInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Possible Types + +| AttributeSelectedOptionInterface Types | +|----------------| +| [`AttributeSelectedOption`](#attributeselectedoption) | + +#### Example + +```json +{ + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOptions + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | + +#### Example + +```json +{ + "code": 4, + "selected_options": [AttributeSelectedOptionInterface] +} +``` + + + +### AttributeValue + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `value` - [`String!`](#string) | The attribute value. | + +#### Example + +```json +{ + "code": "4", + "value": "abc123" +} +``` + + + +### AttributeValueInput + +Specifies the value for attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | +| `value` - [`String`](#string) | The value assigned to the attribute. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "selected_options": [AttributeInputSelectedOption], + "value": "abc123" +} +``` + + + +### AttributeValueInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | + +#### Possible Types + +| AttributeValueInterface Types | +|----------------| +| [`AttributeValue`](#attributevalue) | +| [`AttributeSelectedOptions`](#attributeselectedoptions) | +| [`GiftCartAttributeValue`](#giftcartattributevalue) | + +#### Example + +```json +{"code": 4} +``` + + + +### AttributesFormOutput + +Metadata of EAV attributes associated to form + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AttributesMetadataOutput + +Metadata of EAV attributes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AvailableCurrency + +Defines the code and symbol of a currency that can be used for purchase orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](#string) | Currency symbol, for example $. | + +#### Example + +```json +{"code": "AFN", "symbol": "xyz789"} +``` + + + +### AvailablePaymentMethod + +Describes a payment method that the shopper can use to pay for the order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "is_deferred": false, + "title": "abc123" +} +``` + + + +### AvailableShippingMethod + +Contains details about the possible shipping methods and carriers. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `error_message` - [`String`](#string) | Describes an error condition. | +| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "available": false, + "base_amount": Money, + "carrier_code": "abc123", + "carrier_title": "xyz789", + "error_message": "xyz789", + "method_code": "xyz789", + "method_title": "abc123", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### BatchMutationStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUCCESS` | | +| `FAILURE` | | +| `MIXED_RESULTS` | | + +#### Example + +```json +""SUCCESS"" +``` + + + +### BillingAddressInput + +Defines the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | +| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 987, + "customer_address_uid": 4, + "same_as_shipping": false, + "use_for_shipping": false +} +``` + + + +### BillingAddressPaymentSourceInput + +The billing address information + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_line_1` - [`String`](#string) | The first line of the address | +| `address_line_2` - [`String`](#string) | The second line of the address | +| `city` - [`String`](#string) | The city of the address | +| `country_code` - [`String!`](#string) | The country of the address | +| `postal_code` - [`String`](#string) | The postal code of the address | +| `region` - [`String`](#string) | The region of the address | + +#### Example + +```json +{ + "address_line_1": "xyz789", + "address_line_2": "xyz789", + "city": "xyz789", + "country_code": "abc123", + "postal_code": "xyz789", + "region": "abc123" +} +``` + + + +### BillingCartAddress + +Contains details about the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "city": "abc123", + "company": "abc123", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": 4, + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "xyz789", + "id": 123, + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "xyz789", + "region": CartAddressRegion, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": "4", + "vat_id": "abc123" +} +``` + + + +### Boolean + +The `Boolean` scalar type represents `true` or `false`. + + + +### BraintreeCcVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "abc123", + "public_hash": "xyz789" +} +``` + + + +### BraintreeInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#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!`](#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!`](#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | + +#### Example + +```json +{ + "device_data": "xyz789", + "is_active_payment_token_enabler": true, + "payment_method_nonce": "xyz789" +} +``` + + + +### BraintreeVaultInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `device_data` - [`String`](#string) | | +| `public_hash` - [`String!`](#string) | | + +#### Example + +```json +{ + "device_data": "xyz789", + "public_hash": "abc123" +} +``` + + + +### Breadcrumb + +Contains details about an individual category that comprises a breadcrumb. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | +| `category_level` - [`Int`](#int) | The category level. | +| `category_name` - [`String`](#string) | The display name of the category. | +| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](#string) | The URL key of the category. | +| `category_url_path` - [`String`](#string) | The URL path of the category. | + +#### Example + +```json +{ + "category_id": 123, + "category_level": 987, + "category_name": "abc123", + "category_uid": 4, + "category_url_key": "xyz789", + "category_url_path": "abc123" +} +``` + + + +### BundleCartItem + +An implementation for bundle product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "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": "abc123", + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleCreditMemoItem + +Defines bundle product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 123.45 +} +``` + + + +### BundleInvoiceItem + +Defines bundle product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 987.65 +} +``` + + + +### BundleItem + +Defines an individual item within a bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | +| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | +| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | +| `sku` - [`String`](#string) | The SKU of the bundle product. | +| `title` - [`String`](#string) | The display name of the item. | +| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | + +#### Example + +```json +{ + "option_id": 987, + "options": [BundleItemOption], + "position": 123, + "price_range": PriceRange, + "required": true, + "sku": "xyz789", + "title": "xyz789", + "type": "abc123", + "uid": "4" +} +``` + + + +### BundleItemOption + +Defines the characteristics that comprise a specific bundle item and its options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | +| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | +| `label` - [`String`](#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | +| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | +| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | + +#### Example + +```json +{ + "can_change_quantity": true, + "id": 123, + "is_default": true, + "label": "xyz789", + "position": 987, + "price": 123.45, + "price_type": "FIXED", + "product": ProductInterface, + "qty": 987.65, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleOptionInput + +Defines the input for a bundle option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `id` - [`Int!`](#int) | The ID of the option. | +| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | +| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | + +#### Example + +```json +{ + "id": 123, + "quantity": 123.45, + "value": ["xyz789"] +} +``` + + + +### BundleOrderItem + +Defines bundle product options for `OrderItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "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": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "product_type": "abc123", + "product_url_key": "abc123", + "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": 987.65, + "selected_options": [OrderItemOption], + "status": "abc123" +} +``` + + + +### BundleProduct + +Defines basic features of a bundle product and contains multiple BundleItems. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | +| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | +| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 987, + "country_of_manufacture": "xyz789", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "dynamic_price": false, + "dynamic_sku": true, + "dynamic_weight": true, + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "id": 123, + "image": ProductImage, + "is_returnable": "abc123", + "items": [BundleItem], + "manufacturer": 123, + "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_from_date": "abc123", + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price": ProductPrices, + "price_details": PriceDetails, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "price_view": "PRICE_RANGE", + "product_links": [ProductLinksInterface], + "quantity": 987.65, + "rating_summary": 123.45, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "ship_bundle_items": "TOGETHER", + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": false, + "stock_status": "IN_STOCK", + "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": "xyz789", + "url_path": "abc123", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 123.45 +} +``` + + + +### BundleProductCartItemInput + +Defines a single bundle product. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | + +#### Example + +```json +{ + "bundle_options": [BundleOptionInput], + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### BundleRequisitionListItem + +Contains details about bundle products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | + +#### Example + +```json +{ + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### BundleShipmentItem + +Defines bundle product options for `ShipmentItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 987.65 +} +``` + + + +### BundleWishlistItem + +Defines bundle product options for `WishlistItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### ButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `label` - [`String`](#string) | The button label | +| `layout` - [`String`](#string) | The button layout | +| `shape` - [`String`](#string) | The button shape | +| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | +| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | + +#### Example + +```json +{ + "color": "abc123", + "height": 987, + "label": "xyz789", + "layout": "xyz789", + "shape": "abc123", + "tagline": false, + "use_default_height": false +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-1.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md similarity index 64% rename from src/pages/includes/autogenerated/graphql-api-2-4-9-types-1.md rename to src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md index 4d102fb7b..9b6e2e2e5 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-1.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-c-e.md @@ -1,6866 +1,7563 @@ ## Types -### AcceptNegotiableQuoteTemplateInput +### CancelNegotiableQuoteTemplateInput -Specifies the quote template id to accept quote template. +Specifies the quote template id of the quote template to cancel #### Input Fields | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": 4} +{ + "cancellation_comment": "xyz789", + "template_id": "4" +} ``` -### AddBundleProductsToCartInput - -Defines the bundle products to add to the cart. +### CancelOrderError -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[BundleProductCartItemInput]!`](#bundleproductcartiteminput) | An array of bundle products to add. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [BundleProductCartItemInput] + "code": "ORDER_CANCELLATION_DISABLED", + "message": "abc123" } ``` -### AddBundleProductsToCartOutput - -Contains details about the cart after adding bundle products. +### CancelOrderErrorCode -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `ORDER_CANCELLATION_DISABLED` | | +| `UNDEFINED` | | +| `UNAUTHORISED` | | +| `ORDER_NOT_FOUND` | | +| `PARTIAL_ORDER_ITEM_SHIPPED` | | +| `INVALID_ORDER_STATUS` | | #### Example ```json -{"cart": Cart} +""ORDER_CANCELLATION_DISABLED"" ``` -### AddConfigurableProductsToCartInput +### CancelOrderInput -Defines the configurable products to add to the cart. +Defines the order to cancel. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[ConfigurableProductCartItemInput]!`](#configurableproductcartiteminput) | An array of configurable products to add. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](#string) | Cancellation reason. | #### Example ```json -{ - "cart_id": "abc123", - "cart_items": [ConfigurableProductCartItemInput] -} +{"order_id": 4, "reason": "abc123"} ``` -### AddConfigurableProductsToCartOutput +### CancelOrderOutput -Contains details about the cart after adding configurable products. +Contains the updated customer order and error message if any. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddDownloadableProductsToCartInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `errorV2` - [`CancelOrderError`](#cancelordererror) | | +| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [DownloadableProductCartItemInput] + "error": "abc123", + "errorV2": CancelOrderError, + "order": CustomerOrder } ``` -### AddDownloadableProductsToCartOutput - -Contains details about the cart after adding downloadable products. +### CancellationReason #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### AddGiftRegistryRegistrantInput - -Defines a new registrant. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](#string) | The email address of the registrant. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `description` - [`String!`](#string) | | #### Example ```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "xyz789", - "firstname": "xyz789", - "lastname": "abc123" -} +{"description": "xyz789"} ``` -### AddGiftRegistryRegistrantsOutput - -Contains the results of a request to add registrants. +### Card #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `bin_details` - [`CardBin`](#cardbin) | Card bin details | +| `card_expiry_month` - [`String`](#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](#string) | Expiration year of the card | +| `last_digits` - [`String`](#string) | Last four digits of the card | +| `name` - [`String`](#string) | Name on the card | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "bin_details": CardBin, + "card_expiry_month": "abc123", + "card_expiry_year": "xyz789", + "last_digits": "abc123", + "name": "abc123" +} ``` -### AddProductsToCartOutput - -Contains details about the cart after adding products to it. +### CardBin #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after products have been added. | -| `user_errors` - [`[Error]!`](#error) | Contains errors encountered while adding an item to the cart. | +| `bin` - [`String`](#string) | Card bin number | #### Example ```json -{ - "cart": Cart, - "user_errors": [Error] -} +{"bin": "abc123"} ``` -### AddProductsToCompareListInput +### CardPaymentSourceInput -Contains products to add to an existing compare list. +The card payment source information #### Input Fields | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](#string) | The name on the cardholder | #### Example ```json -{"products": [4], "uid": 4} +{ + "billing_address": BillingAddressPaymentSourceInput, + "name": "xyz789" +} ``` -### AddProductsToNewCartOutput +### CardPaymentSourceOutput -Contains details about the cart after adding products to it. +The card payment source information #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `brand` - [`String`](#string) | The brand of the card | +| `expiry` - [`String`](#string) | The expiry of the card | +| `last_digits` - [`String`](#string) | The last digits of the card | #### Example ```json { - "cart": Cart, - "user_errors": [CartUserInputError] + "brand": "xyz789", + "expiry": "abc123", + "last_digits": "xyz789" } ``` -### AddProductsToRequisitionListOutput +### Cart -Output of the request to add products to a requisition list. +Contains the contents and other details about a guest or customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | +| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | +| `email` - [`String`](#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. *(Deprecated: Use `itemsV2` instead.)* | +| `itemsV2` - [`CartItems`](#cartitems) | | +| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `rules` - [`[CartRuleStorefront]`](#cartrulestorefront) | Provides applied cart rules in the current active cart | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "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": true, + "items": [CartItemInterface], + "itemsV2": CartItems, + "prices": CartPrices, + "printed_card_included": true, + "rules": [CartRuleStorefront], + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [ShippingCartAddress], + "total_quantity": 123.45 +} ``` -### AddProductsToWishlistOutput +### CartAddressCountry -Contains the customer's wish list and any errors encountered. +Contains details the country in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `code` - [`String!`](#string) | The country code. | +| `label` - [`String!`](#string) | The display label for the country. | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "code": "xyz789", + "label": "abc123" } ``` -### AddPurchaseOrderCommentInput +### CartAddressInput -Contains the comment to be added to a purchase order. +Defines the billing or shipping address to be applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String!`](#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "comment": "abc123", - "purchase_order_uid": 4 + "city": "abc123", + "company": "abc123", + "country_code": "abc123", + "custom_attributes": [AttributeValueInput], + "fax": "abc123", + "firstname": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", + "region": "xyz789", + "region_id": 123, + "save_in_address_book": true, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "abc123" } ``` -### AddPurchaseOrderCommentOutput - -Contains the successfully added comment. +### CartAddressInterface #### Fields | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | - -#### Example - -```json -{"comment": PurchaseOrderComment} -``` - - - -### AddPurchaseOrderItemsToCartInput - -Defines the purchase order and cart to act on. +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | -| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | +| CartAddressInterface Types | +|----------------| +| [`ShippingCartAddress`](#shippingcartaddress) | +| [`BillingCartAddress`](#billingcartaddress) | #### Example ```json { - "cart_id": "xyz789", - "purchase_order_uid": 4, - "replace_existing_cart_items": false + "city": "xyz789", + "company": "xyz789", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": "4", + "fax": "xyz789", + "firstname": "abc123", + "id": 987, + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": CartAddressRegion, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "4", + "vat_id": "abc123" } ``` -### AddRequisitionListItemToCartUserError +### CartAddressRegion -Contains details about why an attempt to add items to the requistion list failed. +Contains details about the region in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | -| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | +| `code` - [`String`](#string) | The state or province code. | +| `label` - [`String`](#string) | The display label for the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "message": "abc123", - "type": "OUT_OF_STOCK" + "code": "abc123", + "label": "xyz789", + "region_id": 123 } ``` -### AddRequisitionListItemToCartUserErrorType +### CartDiscount -#### Values +Contains information about discounts applied to the cart. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `OUT_OF_STOCK` | | -| `UNAVAILABLE_SKU` | | -| `OPTIONS_UPDATED` | | -| `LOW_QUANTITY` | | +| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | +| `label` - [`[String]!`](#string) | The description of the discount. | #### Example ```json -""OUT_OF_STOCK"" +{ + "amount": Money, + "label": ["abc123"] +} ``` -### AddRequisitionListItemsToCartOutput - -Output of the request to add items in a requisition list to the cart. +### CartDiscountType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | -| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | +| `ITEM` | | +| `SHIPPING` | | #### Example ```json -{ - "add_requisition_list_items_to_cart_user_errors": [ - AddRequisitionListItemToCartUserError - ], - "cart": Cart, - "status": false -} +""ITEM"" ``` -### AddReturnCommentInput - -Defines a return comment. +### CartItemError -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String!`](#string) | The text added to the return request. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | +| `message` - [`String!`](#string) | A localized error message | #### Example ```json -{ - "comment_text": "xyz789", - "return_uid": "4" -} +{"code": "UNDEFINED", "message": "xyz789"} ``` -### AddReturnCommentOutput - -Contains details about the return request. +### CartItemErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `UNDEFINED` | | +| `ITEM_QTY` | | +| `ITEM_INCREMENTS` | | #### Example ```json -{"return": Return} +""UNDEFINED"" ``` -### AddReturnTrackingInput +### CartItemInput -Defines tracking information to be added to the return. +Defines an item to be added to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | +| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | #### Example ```json { - "carrier_uid": 4, - "return_uid": 4, - "tracking_number": "xyz789" + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 123.45, + "selected_options": [4], + "sku": "abc123" } ``` -### AddReturnTrackingOutput +### CartItemInterface -Contains the response after adding tracking information. +An interface for products in a cart. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Possible Types + +| CartItemInterface Types | +|----------------| +| [`SimpleCartItem`](#simplecartitem) | +| [`VirtualCartItem`](#virtualcartitem) | +| [`ConfigurableCartItem`](#configurablecartitem) | +| [`DownloadableCartItem`](#downloadablecartitem) | +| [`BundleCartItem`](#bundlecartitem) | +| [`GiftCardCartItem`](#giftcardcartitem) | #### Example ```json { - "return": Return, - "return_shipping_tracking": ReturnShippingTracking + "discount": [Discount], + "errors": [CartItemError], + "id": "xyz789", + "is_available": true, + "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" } ``` -### AddSimpleProductsToCartInput +### CartItemPrices -Defines the simple and group products to add to the cart. +Contains details about the price of the item, including taxes and discounts. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[SimpleProductCartItemInput]!`](#simpleproductcartiteminput) | An array of simple and group items to add. | +| Field Name | Description | +|------------|-------------| +| `catalog_discount` - [`ProductDiscount`](#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](#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!`](#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`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | #### Example ```json { - "cart_id": "abc123", - "cart_items": [SimpleProductCartItemInput] + "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 } ``` -### AddSimpleProductsToCartOutput +### CartItemQuantity + +Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | + +#### Example + +```json +{"cart_item_id": 123, "quantity": 123.45} +``` + + + +### CartItemSelectedOptionValuePrice -Contains details about the cart after adding simple or group products. +Contains details about the price of a selected customizable value. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](#float) | A price value. | #### Example ```json -{"cart": Cart} +{ + "type": "FIXED", + "units": "abc123", + "value": 987.65 +} ``` -### AddVirtualProductsToCartInput +### CartItemUpdateInput -Defines the virtual products to add to the cart. +A single item to be updated. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_items` - [`[VirtualProductCartItemInput]!`](#virtualproductcartiteminput) | An array of virtual products to add. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | #### Example ```json { - "cart_id": "xyz789", - "cart_items": [VirtualProductCartItemInput] + "cart_item_id": 987, + "cart_item_uid": "4", + "customizable_options": [CustomizableOptionInput], + "gift_message": GiftMessageInput, + "gift_wrapping_id": 4, + "quantity": 123.45 } ``` -### AddVirtualProductsToCartOutput - -Contains details about the cart after adding virtual products. +### CartItems #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned cart items. | #### Example ```json -{"cart": Cart} +{ + "items": [CartItemInterface], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### AddWishlistItemsToCartOutput +### CartPrices -Contains the resultant wish list and any error information. +Contains details about the final price of items in the cart, including discount and tax information. #### Fields | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | +| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | +| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | #### Example ```json { - "add_wishlist_items_to_cart_user_errors": [ - WishlistCartUserInputError - ], - "status": true, - "wishlist": Wishlist + "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 } ``` -### Aggregation - -Contains information for each filterable option (such as price, category `UID`, and custom attributes). +### CartRuleStorefront #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | Attribute code of the aggregation group. | -| `count` - [`Int`](#int) | The number of options in the aggregation group. | -| `label` - [`String`](#string) | The aggregation display name. | -| `options` - [`[AggregationOption]`](#aggregationoption) | Array of options for the aggregation. | -| `position` - [`Int`](#int) | The relative position of the attribute in a layered navigation block. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartRule` object. | #### Example ```json -{ - "attribute_code": "xyz789", - "count": 987, - "label": "abc123", - "options": [AggregationOption], - "position": 987 -} +{"uid": "4"} ``` -### AggregationOption +### CartTaxItem -An implementation of `AggregationOptionInterface`. +Contains tax information about an item in the cart. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `label` - [`String!`](#string) | The description of the tax. | #### Example ```json { - "count": 987, - "label": "abc123", - "value": "xyz789" + "amount": Money, + "label": "abc123" } ``` -### AggregationOptionInterface - -Defines aggregation option fields. +### CartUserInputError #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int`](#int) | The number of items that match the aggregation option. | -| `label` - [`String`](#string) | The display label for an aggregation option. | -| `value` - [`String!`](#string) | The internal ID that represents the value of the option. | - -#### Possible Types - -| AggregationOptionInterface Types | -|----------------| -| [`AggregationOption`](#aggregationoption) | +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "count": 987, - "label": "xyz789", - "value": "xyz789" + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" } ``` -### AggregationsCategoryFilterInput - -Filter category aggregations in layered navigation. +### CartUserInputErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `includeDirectChildrenOnly` - [`Boolean`](#boolean) | Indicates whether to include only direct subcategories or all children categories at all levels. | +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `COULD_NOT_FIND_CART_ITEM` | | +| `REQUIRED_PARAMETER_MISSING` | | +| `INVALID_PARAMETER_VALUE` | | +| `UNDEFINED` | | +| `PERMISSION_DENIED` | | #### Example ```json -{"includeDirectChildrenOnly": false} +""PRODUCT_NOT_FOUND"" ``` -### AggregationsFilterInput - -An input object that specifies the filters used in product aggregations. +### CatalogAttributeApplyToEnum -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `category` - [`AggregationsCategoryFilterInput`](#aggregationscategoryfilterinput) | Filter category aggregations in layered navigation. | +| Enum Value | Description | +|------------|-------------| +| `SIMPLE` | | +| `VIRTUAL` | | +| `BUNDLE` | | +| `DOWNLOADABLE` | | +| `CONFIGURABLE` | | +| `GROUPED` | | +| `CATEGORY` | | #### Example ```json -{"category": AggregationsCategoryFilterInput} +""SIMPLE"" ``` -### ApplePayConfig +### CatalogAttributeMetadata + +Swatch attribute metadata. #### Fields | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | +| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example ```json { - "button_styles": ButtonStyles, - "code": "xyz789", - "is_visible": true, - "payment_intent": "abc123", - "payment_source": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" + "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": true, + "is_html_allowed_on_front": true, + "is_required": false, + "is_searchable": false, + "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": false, + "label": "abc123", + "options": [CustomAttributeOptionInterface], + "swatch_input_type": "BOOLEAN", + "update_product_preview_image": true, + "use_product_image_for_swatch": false, + "used_in_product_listing": false } ``` -### ApplePayMethodInput +### CategoryFilterInput -Apple Pay inputs +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | +| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | +| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" + "category_uid": FilterEqualTypeInput, + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput, + "parent_category_uid": FilterEqualTypeInput, + "parent_id": FilterEqualTypeInput, + "url_key": FilterEqualTypeInput, + "url_path": FilterEqualTypeInput } ``` -### AppliedCoupon +### CategoryInterface -Contains the applied coupon code. +Contains the full set of attributes that can be returned in a category search. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | + +#### Possible Types + +| CategoryInterface Types | +|----------------| +| [`CategoryTree`](#categorytree) | #### Example ```json -{"code": "xyz789"} +{ + "automatic_sorting": "xyz789", + "available_sort_by": ["xyz789"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "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, + "id": 123, + "image": "abc123", + "include_in_menu": 987, + "is_anchor": 987, + "landing_page": 123, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "abc123", + "meta_title": "xyz789", + "name": "xyz789", + "path": "abc123", + "path_in_store": "xyz789", + "position": 987, + "product_count": 987, + "products": CategoryProducts, + "staged": true, + "uid": 4, + "updated_at": "abc123", + "url_key": "abc123", + "url_path": "xyz789", + "url_suffix": "xyz789" +} ``` -### AppliedGiftCard +### CategoryProducts -Contains an applied gift card with applied and remaining balance. +Contains details about the products assigned to a category. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | -| `code` - [`String`](#string) | The gift card account code. | -| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#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 ```json { - "applied_balance": Money, - "code": "abc123", - "current_balance": Money, - "expiration_date": "abc123" + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### AppliedStoreCredit +### CategoryResult -Contains the applied and current balances. +Contains a collection of `CategoryTree` objects and pagination information. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | +| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | +| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | #### Example ```json { - "applied_balance": Money, - "current_balance": Money, - "enabled": true + "items": [CategoryTree], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### ApplyCouponToCartInput +### CategoryTree -Specifies the coupon code to apply to the cart. +Contains the hierarchy of categories. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| Field Name | Description | +|------------|-------------| +| `automatic_sorting` - [`String`](#string) | | +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | +| `children_count` - [`String`](#string) | | +| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | +| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | +| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | #### Example ```json { - "cart_id": "abc123", - "coupon_code": "abc123" + "automatic_sorting": "xyz789", + "available_sort_by": ["xyz789"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "xyz789", + "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": 123, + "image": "xyz789", + "include_in_menu": 123, + "is_anchor": 987, + "landing_page": 987, + "level": 123, + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "path": "xyz789", + "path_in_store": "abc123", + "position": 987, + "product_count": 987, + "products": CategoryProducts, + "redirect_code": 987, + "relative_url": "xyz789", + "staged": true, + "type": "CMS_PAGE", + "uid": 4, + "updated_at": "xyz789", + "url_key": "xyz789", + "url_path": "xyz789", + "url_suffix": "abc123" } ``` -### ApplyCouponToCartOutput +### CheckoutAgreement -Contains details about the cart after applying a coupon. +Defines details about an individual checkout agreement. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](#string) | Required. The text of the agreement. | +| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | +| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | +| `name` - [`String!`](#string) | The name given to the condition. | #### Example ```json -{"cart": Cart} +{ + "agreement_id": 987, + "checkbox_text": "xyz789", + "content": "abc123", + "content_height": "abc123", + "is_html": true, + "mode": "AUTO", + "name": "xyz789" +} ``` -### ApplyCouponsStrategy +### CheckoutAgreementMode -The strategy to apply coupons to the cart. +Indicates how agreements are accepted. #### Values | Enum Value | Description | |------------|-------------| -| `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. | +| `AUTO` | Conditions are automatically accepted upon checkout. | +| `MANUAL` | Shoppers must manually accept the conditions to place an order. | #### Example ```json -""APPEND"" +""AUTO"" ``` -### ApplyCouponsToCartInput +### CheckoutUserInputError -Apply coupons to the cart. +An error encountered while adding an item to the cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | -| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | +| `message` - [`String!`](#string) | A localized error message. | +| `path` - [`[String]!`](#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 ```json { - "cart_id": "xyz789", - "coupon_codes": ["xyz789"], - "type": "APPEND" + "code": "REORDER_NOT_AVAILABLE", + "message": "abc123", + "path": ["abc123"] } ``` -### ApplyGiftCardToCartInput +### CheckoutUserInputErrorCodes -Defines the input required to run the `applyGiftCardToCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | - -#### Example - -```json -{ - "cart_id": "abc123", - "gift_card_code": "abc123" -} -``` - - - -### ApplyGiftCardToCartOutput - -Defines the possible output for the `applyGiftCardToCart` mutation. - -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `REORDER_NOT_AVAILABLE` | | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | #### Example ```json -{"cart": Cart} +""REORDER_NOT_AVAILABLE"" ``` -### ApplyGiftCardToOrder +### ClearCartError -Contains applied gift cards with gift card code and amount. +Contains details about errors encountered when a customer clear cart. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](#string) | The gift card account code. | +| `message` - [`String!`](#string) | A localized error message | +| `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | #### Example ```json -{ - "applied_balance": Money, - "code": "abc123" -} +{"message": "xyz789", "type": "NOT_FOUND"} ``` -### ApplyRewardPointsToCartOutput - -Contains the customer cart. +### ClearCartErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `NOT_FOUND` | | +| `UNAUTHORISED` | | +| `INACTIVE` | | +| `UNDEFINED` | | #### Example ```json -{"cart": Cart} +""NOT_FOUND"" ``` -### ApplyStoreCreditToCartInput +### ClearCartInput -Defines the input required to run the `applyStoreCreditToCart` mutation. +Assigns a specific `cart_id` to the empty cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | #### Example ```json -{"cart_id": "xyz789"} +{"uid": 4} ``` -### ApplyStoreCreditToCartOutput +### ClearCartOutput -Defines the possible output for the `applyStoreCreditToCart` mutation. +Output of the request to clear the customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `cart` - [`Cart`](#cart) | The cart after clear cart items. | +| `errors` - [`[ClearCartError]`](#clearcarterror) | An array of errors encountered while clearing the cart item | #### Example ```json -{"cart": Cart} +{ + "cart": Cart, + "errors": [ClearCartError] +} ``` -### AreaInput +### ClearCustomerCartOutput -AreaInput defines the parameters which will be used for filter by specified location. +Output of the request to clear the customer cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `radius` - [`Int!`](#int) | The radius for the search in KM. | -| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after clearing items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | #### Example ```json -{"radius": 987, "search_term": "xyz789"} +{"cart": Cart, "status": false} ``` -### AssignCompareListToCustomerOutput - -Contains the results of the request to assign a compare list. +### CloseNegotiableQuoteError -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | #### Example ```json -{"compare_list": CompareList, "result": true} +NegotiableQuoteInvalidStateError ``` -### Attribute +### CloseNegotiableQuoteOperationFailure -Contains details about the attribute, including the code and type. +Contains details about a failed close operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `attribute_options` - [`[AttributeOption]`](#attributeoption) | Attribute options list. | -| `attribute_type` - [`String`](#string) | The data type of the attribute. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | -| `input_type` - [`String`](#string) | The frontend input type of the attribute. | -| `storefront_properties` - [`StorefrontProperties`](#storefrontproperties) | Details about the storefront properties configured for the attribute. | +| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "attribute_code": "xyz789", - "attribute_options": [AttributeOption], - "attribute_type": "abc123", - "entity_type": "xyz789", - "input_type": "abc123", - "storefront_properties": StorefrontProperties + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": "4" } ``` -### AttributeEntityTypeEnum - -List of all entity types. Populated by the modules introducing EAV entities. +### CloseNegotiableQuoteOperationResult -#### Values +#### Types -| Enum Value | Description | -|------------|-------------| -| `CATALOG_PRODUCT` | | -| `CATALOG_CATEGORY` | | -| `CUSTOMER` | | -| `CUSTOMER_ADDRESS` | | -| `RMA_ITEM` | | +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | #### Example ```json -""CATALOG_PRODUCT"" +NegotiableQuoteUidOperationSuccess ``` -### AttributeFilterInput +### CloseNegotiableQuotesInput -An input object that specifies the filters used for attributes. +Defines the negotiable quotes to mark as closed. #### Input Fields | Input Field | Description | |-------------|-------------| -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{ - "is_comparable": false, - "is_filterable": false, - "is_filterable_in_search": false, - "is_html_allowed_on_front": true, - "is_searchable": true, - "is_used_for_customer_segment": 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": false, - "used_in_product_listing": false -} +{"quote_uids": [4]} ``` -### AttributeFrontendInputEnum +### CloseNegotiableQuotesOutput -EAV attribute frontend input types. +Contains the closed negotiable quotes and other negotiable quotes the company user can view. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `WEIGHT` | | -| `UNDEFINED` | | +| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example ```json -""BOOLEAN"" +{ + "closed_quotes": [NegotiableQuote], + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" +} ``` -### AttributeInput +### CmsBlock -Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. +Contains details about a specific CMS block. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| Field Name | Description | +|------------|-------------| +| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | +| `identifier` - [`String`](#string) | The CMS block identifier. | +| `title` - [`String`](#string) | The title assigned to the CMS block. | #### Example ```json { - "attribute_code": "xyz789", - "entity_type": "xyz789" + "content": "abc123", + "identifier": "abc123", + "title": "abc123" } ``` -### AttributeInputSelectedOption +### CmsBlocks -Specifies selected option for a select or multiselect attribute value. +Contains an array CMS block items. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | #### Example ```json -{"value": "xyz789"} +{"items": [CmsBlock]} ``` -### AttributeMetadata +### CmsPage -Base EAV implementation of CustomAttributeMetadataInterface. +Contains details about a CMS page. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | +| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | +| `identifier` - [`String`](#string) | The ID of a CMS page. | +| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | +| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | +| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | #### Example ```json { - "code": "4", - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_required": true, - "is_unique": true, - "label": "abc123", - "options": [CustomAttributeOptionInterface] + "content": "xyz789", + "content_heading": "xyz789", + "identifier": "xyz789", + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "page_layout": "xyz789", + "redirect_code": 123, + "relative_url": "xyz789", + "title": "xyz789", + "type": "CMS_PAGE", + "url_key": "abc123" } ``` -### AttributeMetadataError - -Attribute metadata retrieval error. +### ColorSwatchData #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | -| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{ - "message": "xyz789", - "type": "ENTITY_NOT_FOUND" -} +{"value": "abc123"} ``` -### AttributeMetadataErrorType +### CompaniesSortFieldEnum -Attribute metadata retrieval error types. +The fields available for sorting the customer companies. #### Values | Enum Value | Description | |------------|-------------| -| `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. | +| `NAME` | The name of the company. | #### Example ```json -""ENTITY_NOT_FOUND"" +""NAME"" ``` -### AttributeOption +### CompaniesSortInput -Defines an attribute option. +Specifies which field to sort on, and whether to return the results in ascending or descending order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `label` - [`String`](#string) | The label assigned to the attribute option. | -| `value` - [`String`](#string) | The attribute option value. | +| Input Field | Description | +|-------------|-------------| +| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | +| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example ```json -{ - "label": "abc123", - "value": "abc123" -} +{"field": "NAME", "order": "ASC"} ``` -### AttributeOptionMetadata +### Company -Base EAV implementation of CustomAttributeOptionInterface. +Contains the output schema for a company. #### Fields | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | +| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | +| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | +| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | +| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | +| `email` - [`String`](#string) | The email address of the company contact. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | +| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | +| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | +| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | +| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | +| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | +| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "is_default": false, - "label": "abc123", - "value": "xyz789" -} -``` - - - -### AttributeSelectedOption - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | - -#### Example - -```json -{ - "label": "abc123", - "value": "abc123" + "acl_resources": [CompanyAclResource], + "company_admin": Customer, + "credit": CompanyCredit, + "credit_history": CompanyCreditHistory, + "email": "abc123", + "id": 4, + "legal_address": CompanyLegalAddress, + "legal_name": "abc123", + "name": "abc123", + "payment_methods": ["abc123"], + "reseller_id": "abc123", + "role": CompanyRole, + "roles": CompanyRoles, + "sales_representative": CompanySalesRepresentative, + "structure": CompanyStructure, + "team": CompanyTeam, + "user": Customer, + "users": CompanyUsers, + "vat_tax_id": "xyz789" } ``` -### AttributeSelectedOptionInterface +### CompanyAclResource + +Contains details about the access control list settings of a resource. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | - -#### Possible Types - -| AttributeSelectedOptionInterface Types | -|----------------| -| [`AttributeSelectedOption`](#attributeselectedoption) | +| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | +| `text` - [`String`](#string) | The label assigned to the ACL resource. | #### Example ```json { - "label": "xyz789", - "value": "xyz789" + "children": [CompanyAclResource], + "id": 4, + "sort_order": 987, + "text": "abc123" } ``` -### AttributeSelectedOptions +### CompanyAdminInput -#### Fields +Defines the input schema for creating a company administrator. -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](#string) | The email address of the company administrator. | +| `firstname` - [`String!`](#string) | The company administrator's first name. | +| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](#string) | The job title of the company administrator. | +| `lastname` - [`String!`](#string) | The company administrator's last name. | +| `telephone` - [`String`](#string) | The phone number of the company administrator. | #### Example ```json { - "code": 4, - "selected_options": [AttributeSelectedOptionInterface] + "custom_attributes": [AttributeValueInput], + "email": "abc123", + "firstname": "xyz789", + "gender": 123, + "job_title": "abc123", + "lastname": "xyz789", + "telephone": "xyz789" } ``` -### AttributeValue +### CompanyBasicInfo + +The minimal required information to identify and display the company. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | #### Example ```json -{"code": 4, "value": "abc123"} +{ + "id": "4", + "legal_name": "xyz789", + "name": "abc123", + "status": "PENDING" +} ``` -### AttributeValueInput +### CompanyCreateInput -Specifies the value for attribute. +Defines the input schema for creating a new company. #### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | -| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](#string) | The value assigned to the attribute. | +| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | +| `company_email` - [`String!`](#string) | The email address of the company contact. | +| `company_name` - [`String!`](#string) | The name of the company to create. | +| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "attribute_code": "xyz789", - "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "company_admin": CompanyAdminInput, + "company_email": "abc123", + "company_name": "abc123", + "legal_address": CompanyLegalAddressCreateInput, + "legal_name": "abc123", + "reseller_id": "xyz789", + "vat_tax_id": "xyz789" } ``` -### AttributeValueInterface +### CompanyCredit + +Contains company credit balances and limits. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The attribute code. | - -#### Possible Types - -| AttributeValueInterface Types | -|----------------| -| [`AttributeValue`](#attributevalue) | -| [`AttributeSelectedOptions`](#attributeselectedoptions) | -| [`GiftCartAttributeValue`](#giftcartattributevalue) | +| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | +| `outstanding_balance` - [`Money!`](#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 ```json -{"code": "4"} +{ + "available_credit": Money, + "credit_limit": Money, + "outstanding_balance": Money +} ``` -### AttributesFormOutput +### CompanyCreditHistory -Metadata of EAV attributes associated to form +Contains details about prior company credit operations. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] + "items": [CompanyCreditOperation], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### AttributesMetadataOutput +### CompanyCreditHistoryFilterInput -Metadata of EAV attributes. +Defines a filter for narrowing the results of a credit history search. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| Input Field | Description | +|-------------|-------------| +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] + "custom_reference_number": "abc123", + "operation_type": "ALLOCATION", + "updated_by": "xyz789" } ``` -### AvailableCurrency +### CompanyCreditOperation -Defines the code and symbol of a currency that can be used for purchase orders. +Contains details about a single company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](#string) | The date the operation occurred. | +| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{ + "amount": Money, + "balance": CompanyCredit, + "custom_reference_number": "xyz789", + "date": "xyz789", + "type": "ALLOCATION", + "updated_by": CompanyCreditOperationUser +} ``` -### AvailablePaymentMethod - -Describes a payment method that the shopper can use to pay for the order. +### CompanyCreditOperationType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `title` - [`String!`](#string) | The payment method title. | +| `ALLOCATION` | | +| `UPDATE` | | +| `PURCHASE` | | +| `REIMBURSEMENT` | | +| `REFUND` | | +| `REVERT` | | #### Example ```json -{ - "code": "xyz789", - "is_deferred": false, - "title": "abc123" -} +""ALLOCATION"" ``` -### AvailableShippingMethod +### CompanyCreditOperationUser -Contains details about the possible shipping methods and carriers. +Defines the administrator or company user that submitted a company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `error_message` - [`String`](#string) | Describes an error condition. | -| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | #### Example ```json -{ - "amount": Money, - "available": false, - "base_amount": Money, - "carrier_code": "xyz789", - "carrier_title": "xyz789", - "error_message": "xyz789", - "method_code": "xyz789", - "method_title": "xyz789", - "price_excl_tax": Money, - "price_incl_tax": Money -} +{"name": "xyz789", "type": "CUSTOMER"} ``` -### BatchMutationStatus +### CompanyCreditOperationUserType #### Values | Enum Value | Description | |------------|-------------| -| `SUCCESS` | | -| `FAILURE` | | -| `MIXED_RESULTS` | | +| `CUSTOMER` | | +| `ADMIN` | | #### Example ```json -""SUCCESS"" +""CUSTOMER"" ``` -### BillingAddressInput +### CompanyInvitationInput -Defines the billing address. +Defines the input schema for accepting the company invitation. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | -| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `code` - [`String!`](#string) | The invitation code. | +| `role_id` - [`ID`](#id) | The company role id. | +| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "address": CartAddressInput, - "customer_address_id": 987, - "customer_address_uid": 4, - "same_as_shipping": false, - "use_for_shipping": true + "code": "abc123", + "role_id": 4, + "user": CompanyInvitationUserInput } ``` -### BillingAddressPaymentSourceInput +### CompanyInvitationOutput + +The result of accepting the company invitation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | + +#### Example + +```json +{"success": true} +``` + + + +### CompanyInvitationUserInput -The billing address information +Company user attributes in the invitation. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address_line_1` - [`String`](#string) | The first line of the address | -| `address_line_2` - [`String`](#string) | The second line of the address | -| `city` - [`String`](#string) | The city of the address | -| `country_code` - [`String!`](#string) | The country of the address | -| `postal_code` - [`String`](#string) | The postal code of the address | -| `region` - [`String`](#string) | The region of the address | +| `company_id` - [`ID!`](#id) | The company unique identifier. | +| `customer_id` - [`ID!`](#id) | The customer unique identifier. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The phone number of the company user. | #### Example ```json { - "address_line_1": "abc123", - "address_line_2": "xyz789", - "city": "abc123", - "country_code": "abc123", - "postal_code": "abc123", - "region": "abc123" + "company_id": 4, + "customer_id": "4", + "job_title": "xyz789", + "status": "ACTIVE", + "telephone": "xyz789" } ``` -### BillingCartAddress +### CompanyLegalAddress -Contains details about the billing address. +Contains details about the address where the company is registered to conduct business. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `customer_notes` - [`String`](#string) | *(Deprecated: The field is used only in shipping address.)* | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | +| `postcode` - [`String`](#string) | The company's postal code. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | +| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](#string) | The company's phone number. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "customer_notes": "xyz789", - "fax": "xyz789", - "firstname": "xyz789", - "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", + "city": "abc123", + "country_code": "AF", "postcode": "xyz789", - "prefix": "abc123", - "region": CartAddressRegion, + "region": CustomerAddressRegion, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", - "vat_id": "xyz789" + "telephone": "abc123" } ``` -### Boolean - -The `Boolean` scalar type represents `true` or `false`. +### CompanyLegalAddressCreateInput -#### Example +Defines the input schema for defining a company's legal address. -```json -true -``` +#### Input Fields - +| Input Field | Description | +|-------------|-------------| +| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | +| `postcode` - [`String!`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](#string) | The primary phone number of the company. | + +#### Example + +```json +{ + "city": "abc123", + "country_id": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["xyz789"], + "telephone": "abc123" +} +``` + + + +### CompanyLegalAddressUpdateInput -### BraintreeCcVaultInput +Defines the input schema for updating a company's legal address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | +| `postcode` - [`String`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](#string) | The primary phone number of the company. | #### Example ```json { - "device_data": "xyz789", - "public_hash": "xyz789" + "city": "abc123", + "country_id": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "telephone": "xyz789" } ``` -### BraintreeInput +### CompanyRole -#### Input Fields +Contails details about a single role. -| Input Field | Description | -|-------------|-------------| -| `device_data` - [`String`](#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!`](#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!`](#string) | The one-time payment token generated by Braintree payment gateway based on payment details (Card, PayPal). Required field to make sale transaction. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name assigned to the role. | +| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | +| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | #### Example ```json { - "device_data": "xyz789", - "is_active_payment_token_enabler": true, - "payment_method_nonce": "abc123" + "id": 4, + "name": "xyz789", + "permissions": [CompanyAclResource], + "users_count": 987 } ``` -### BraintreeVaultInput +### CompanyRoleCreateInput + +Defines the input schema for creating a company role. #### Input Fields | Input Field | Description | |-------------|-------------| -| `device_data` - [`String`](#string) | | -| `public_hash` - [`String!`](#string) | | +| `name` - [`String!`](#string) | The name of the role to create. | +| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | #### Example ```json { - "device_data": "abc123", - "public_hash": "xyz789" + "name": "xyz789", + "permissions": ["abc123"] } ``` -### Breadcrumb +### CompanyRoleUpdateInput -Contains details about an individual category that comprises a breadcrumb. +Defines the input schema for updating a company role. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `category_id` - [`Int`](#int) | The ID of the category. *(Deprecated: Use `category_uid` instead.)* | -| `category_level` - [`Int`](#int) | The category level. | -| `category_name` - [`String`](#string) | The display name of the category. | -| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](#string) | The URL key of the category. | -| `category_url_path` - [`String`](#string) | The URL path of the category. | +| Input Field | Description | +|-------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name of the role to update. | +| `permissions` - [`[String]`](#string) | A list of resources the role can access. | #### Example ```json { - "category_id": 987, - "category_level": 123, - "category_name": "xyz789", - "category_uid": 4, - "category_url_key": "abc123", - "category_url_path": "xyz789" + "id": "4", + "name": "abc123", + "permissions": ["xyz789"] } ``` -### BundleCartItem +### CompanyRoles -An implementation for bundle product cart items. +Contains an array of roles. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": true, - "max_qty": 123.45, - "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" + "items": [CompanyRole], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### BundleCreditMemoItem +### CompanySalesRepresentative -Defines bundle product options for `CreditMemoItemInterface`. +Contains details about a company sales representative. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `email` - [`String`](#string) | The email address of the company sales representative. | +| `firstname` - [`String`](#string) | The company sales representative's first name. | +| `lastname` - [`String`](#string) | The company sales representative's last name. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "email": "abc123", + "firstname": "abc123", + "lastname": "xyz789" } ``` -### BundleInvoiceItem +### CompanyStatusEnum -Defines bundle product options for `InvoiceItemInterface`. +Defines the list of company status values. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `PENDING` | Company is pending approval. | +| `APPROVED` | Company is approved. | +| `REJECTED` | Company is rejected. | +| `BLOCKED` | Company is blocked. | #### Example ```json -{ - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} +""PENDING"" ``` -### BundleItem +### CompanyStructure -Defines an individual item within a bundle product. +Contains an array of the individual nodes that comprise the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `option_id` - [`Int`](#int) | An ID assigned to each type of item in a bundle product. *(Deprecated: Use `uid` instead)* | -| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | -| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](#string) | The SKU of the bundle product. | -| `title` - [`String`](#string) | The display name of the item. | -| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | +| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | #### Example ```json -{ - "option_id": 123, - "options": [BundleItemOption], - "position": 123, - "price_range": PriceRange, - "required": true, - "sku": "xyz789", - "title": "xyz789", - "type": "xyz789", - "uid": "4" -} +{"items": [CompanyStructureItem]} +``` + + + +### CompanyStructureEntity + +#### Types + +| Union Types | +|-------------| +| [`CompanyTeam`](#companyteam) | +| [`Customer`](#customer) | + +#### Example + +```json +CompanyTeam ``` -### BundleItemOption +### CompanyStructureItem -Defines the characteristics that comprise a specific bundle item and its options. +Defines an individual node in the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `id` - [`Int`](#int) | The ID assigned to the bundled item option. *(Deprecated: Use `uid` instead)* | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | -| `label` - [`String`](#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | -| `qty` - [`Float`](#float) | Indicates the quantity of this specific bundle item. *(Deprecated: Use `quantity` instead.)* | -| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | +| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | #### Example ```json { - "can_change_quantity": true, - "id": 987, - "is_default": true, - "label": "xyz789", - "position": 123, - "price": 987.65, - "price_type": "FIXED", - "product": ProductInterface, - "qty": 987.65, - "quantity": 987.65, - "uid": "4" + "entity": CompanyTeam, + "id": "4", + "parent_id": 4 } ``` -### BundleOptionInput +### CompanyStructureUpdateInput -Defines the input for a bundle option. +Defines the input schema for updating the company structure. #### Input Fields | Input Field | Description | |-------------|-------------| -| `id` - [`Int!`](#int) | The ID of the option. | -| `quantity` - [`Float!`](#float) | The number of the selected item to add to the cart. | -| `value` - [`[String]!`](#string) | An array with the chosen value of the option. | +| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | #### Example ```json -{ - "id": 987, - "quantity": 123.45, - "value": ["abc123"] -} +{"parent_tree_id": 4, "tree_id": "4"} ``` -### BundleOrderItem +### CompanyTeam -Defines bundle product options for `OrderItemInterface`. +Describes a company team. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID`](#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](#string) | The display name of the team. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, + "description": "abc123", "id": 4, - "parent_sku": "xyz789", - "prices": OrderItemPrices, - "product": ProductInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "abc123" + "name": "xyz789", + "structure_id": 4 } ``` -### BundleProduct +### CompanyTeamCreateInput -Defines basic features of a bundle product and contains multiple BundleItems. +Defines the input schema for creating a company team. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | -| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | -| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `name` - [`String!`](#string) | The display name of the team. | +| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 987, - "country_of_manufacture": "xyz789", - "created_at": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "dynamic_price": false, - "dynamic_sku": true, - "dynamic_weight": true, - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "items": [BundleItem], - "manufacturer": 987, - "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, + "description": "xyz789", "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price": ProductPrices, - "price_details": PriceDetails, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "price_view": "PRICE_RANGE", - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 987.65, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "xyz789", - "review_count": 987, - "reviews": ProductReviews, - "ship_bundle_items": "TOGETHER", - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "xyz789", - "staged": false, - "stock_status": "IN_STOCK", - "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": "abc123", - "websites": [Website], - "weight": 987.65 + "target_id": "4" } ``` -### BundleProductCartItemInput +### CompanyTeamUpdateInput -Defines a single bundle product. +Defines the input schema for updating a company team. #### Input Fields | Input Field | Description | |-------------|-------------| -| `bundle_options` - [`[BundleOptionInput]!`](#bundleoptioninput) | A mandatory array of options for the bundle product, including each chosen option and specified quantity. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the bundle product. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](#string) | The display name of the team. | #### Example ```json { - "bundle_options": [BundleOptionInput], - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput + "description": "abc123", + "id": "4", + "name": "xyz789" } ``` -### BundleRequisitionListItem +### CompanyUpdateInput -Contains details about bundle products added to a requisition list. +Defines the input schema for updating a company. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| Input Field | Description | +|-------------|-------------| +| `company_email` - [`String`](#string) | The email address of the company contact. | +| `company_name` - [`String`](#string) | The name of the company to update. | +| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "company_email": "xyz789", + "company_name": "xyz789", + "legal_address": CompanyLegalAddressUpdateInput, + "legal_name": "xyz789", + "reseller_id": "xyz789", + "vat_tax_id": "xyz789" } ``` -### BundleShipmentItem +### CompanyUserCreateInput -Defines bundle product options for `ShipmentItemInterface`. +Defines the input schema for creating a company user. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The company user's email address | +| `firstname` - [`String!`](#string) | The company user's first name. | +| `job_title` - [`String!`](#string) | The company user's job title or function. | +| `lastname` - [`String!`](#string) | The company user's last name. | +| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `target_id` - [`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!`](#string) | The company user's phone number. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "email": "xyz789", + "firstname": "abc123", + "job_title": "abc123", + "lastname": "abc123", + "role_id": 4, + "status": "ACTIVE", + "target_id": 4, + "telephone": "abc123" } ``` -### BundleWishlistItem +### CompanyUserStatusEnum -Defines bundle product options for `WishlistItemInterface`. +Defines the list of company user status values. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `ACTIVE` | Only active users. | +| `INACTIVE` | Only inactive users. | + +#### Example + +```json +""ACTIVE"" +``` + + + +### CompanyUserUpdateInput + +Defines the input schema for updating a company user. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String`](#string) | The company user's email address. | +| `firstname` - [`String`](#string) | The company user's first name. | +| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](#string) | The company user's job title or function. | +| `lastname` - [`String`](#string) | The company user's last name. | +| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The company user's phone number. | #### Example ```json { - "added_at": "abc123", - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "email": "abc123", + "firstname": "abc123", "id": 4, - "product": ProductInterface, - "quantity": 987.65 + "job_title": "xyz789", + "lastname": "abc123", + "role_id": "4", + "status": "ACTIVE", + "telephone": "xyz789" } ``` -### ButtonStyles +### CompanyUsers + +Contains details about company users. #### Fields | Field Name | Description | |------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `label` - [`String`](#string) | The button label | -| `layout` - [`String`](#string) | The button layout | -| `shape` - [`String`](#string) | The button shape | -| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | -| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | +| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The number of objects returned. | #### Example ```json { - "color": "xyz789", - "height": 123, - "label": "xyz789", - "layout": "xyz789", - "shape": "abc123", - "tagline": false, - "use_default_height": false + "items": [Customer], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### CancelNegotiableQuoteTemplateInput +### CompanyUsersFilterInput -Specifies the quote template id of the quote template to cancel +Defines the filter for returning a list of company users. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | #### Example ```json -{ - "cancellation_comment": "xyz789", - "template_id": "4" -} +{"status": "ACTIVE"} ``` -### CancelOrderError +### ComparableAttribute + +Contains an attribute code that is used for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](#string) | A localized error message. | +| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](#string) | The label of the attribute code. | #### Example ```json { - "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "code": "xyz789", + "label": "abc123" } ``` -### CancelOrderErrorCode - -#### Values +### ComparableItem -| Enum Value | Description | -|------------|-------------| -| `ORDER_CANCELLATION_DISABLED` | | -| `UNDEFINED` | | -| `UNAUTHORISED` | | -| `ORDER_NOT_FOUND` | | -| `PARTIAL_ORDER_ITEM_SHIPPED` | | -| `INVALID_ORDER_STATUS` | | +Defines an object used to iterate through items for product comparisons. -#### Example - -```json -""ORDER_CANCELLATION_DISABLED"" -``` - - - -### CancelOrderInput - -Defines the order to cancel. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](#string) | Cancellation reason. | - -#### Example - -```json -{"order_id": 4, "reason": "xyz789"} -``` - - - -### CancelOrderOutput - -Contains the updated customer order and error message if any. - -#### Fields +#### Fields | Field Name | Description | |------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | -| `errorV2` - [`CancelOrderError`](#cancelordererror) | | -| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | +| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | #### Example ```json { - "error": "abc123", - "errorV2": CancelOrderError, - "order": CustomerOrder + "attributes": [ProductAttribute], + "product": ProductInterface, + "uid": "4" } ``` -### CancellationReason +### CompareList + +Contains iterable information such as the array of items, the count, and attributes that represent the compare list. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String!`](#string) | | +| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | +| `item_count` - [`Int!`](#int) | The number of items in the compare list. | +| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | #### Example ```json -{"description": "xyz789"} +{ + "attributes": [ComparableAttribute], + "item_count": 987, + "items": [ComparableItem], + "uid": "4" +} ``` -### Card +### CompleteOrderInput -#### Fields +Update the quote and complete the order -| Field Name | Description | -|------------|-------------| -| `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](#string) | Expiration year of the card | -| `last_digits` - [`String`](#string) | Last four digits of the card | -| `name` - [`String`](#string) | Name on the card | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `id` - [`String!`](#string) | PayPal order ID | #### Example ```json { - "bin_details": CardBin, - "card_expiry_month": "xyz789", - "card_expiry_year": "abc123", - "last_digits": "xyz789", - "name": "xyz789" + "cartId": "abc123", + "id": "xyz789" } ``` -### CardBin +### ComplexTextValue #### Fields | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `html` - [`String!`](#string) | Text that can contain HTML tags. | #### Example ```json -{"bin": "xyz789"} +{"html": "xyz789"} ``` -### CardPaymentSourceInput +### ConfigurableAttributeOption -The card payment source information +Contains details about a configurable product attribute option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](#string) | The name on the cardholder | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The ID assigned to the attribute. | +| `label` - [`String`](#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "billing_address": BillingAddressPaymentSourceInput, - "name": "abc123" + "code": "abc123", + "label": "abc123", + "uid": 4, + "value_index": 987 } ``` -### CardPaymentSourceOutput +### ConfigurableCartItem -The card payment source information +An implementation for configurable product cart items. #### Fields | Field Name | Description | |------------|-------------| -| `brand` - [`String`](#string) | The brand of the card | -| `expiry` - [`String`](#string) | The expiry of the card | -| `last_digits` - [`String`](#string) | The last digits of the card | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "brand": "abc123", - "expiry": "abc123", - "last_digits": "abc123" + "available_gift_wrapping": [GiftWrapping], + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "abc123", + "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 } ``` -### Cart +### ConfigurableOptionAvailableForSelection -Contains the contents and other details about a guest or customer cart. +Describes configurable options that have been selected and can be selected as a result of the previous selections. #### Fields | Field Name | Description | |------------|-------------| -| `applied_coupon` - [`AppliedCoupon`](#appliedcoupon) | *(Deprecated: Use `applied_coupons` instead.)* | -| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | -| `email` - [`String`](#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | An array of products that have been added to the cart. *(Deprecated: Use `itemsV2` instead.)* | -| `itemsV2` - [`CartItems`](#cartitems) | | -| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `rules` - [`[CartRuleStorefront]`](#cartrulestorefront) | Provides applied cart rules in the current active cart | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | #### Example ```json { - "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": false, - "rules": [CartRuleStorefront], - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "attribute_code": "xyz789", + "option_value_uids": [4] } ``` -### CartAddressCountry - -Contains details the country in a billing or shipping address. +### ConfigurableOrderItem #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "code": "abc123", - "label": "abc123" + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "parent_sku": "abc123", + "prices": OrderItemPrices, + "product": ProductInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "xyz789", + "product_url_key": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "abc123" } ``` -### CartAddressInput +### ConfigurableProduct -Defines the billing or shipping address to be applied to the cart. +Defines basic features of a configurable product and its simple product variants. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String!`](#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | +| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", - "country_code": "abc123", - "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", - "region": "xyz789", - "region_id": 123, - "save_in_address_book": false, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "abc123" + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "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, + "gift_message_available": false, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 987, + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 987.65, + "rating_summary": 987.65, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": true, + "stock_status": "IN_STOCK", + "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", + "variants": [ConfigurableVariant], + "websites": [Website], + "weight": 123.45 } ``` -### CartAddressInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +### ConfigurableProductCartItemInput -#### Possible Types +#### Input Fields -| CartAddressInterface Types | -|----------------| -| [`ShippingCartAddress`](#shippingcartaddress) | -| [`BillingCartAddress`](#billingcartaddress) | +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | +| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | +| `variant_sku` - [`String`](#string) | | #### Example ```json { - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "abc123", - "id": 123, - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "abc123", - "region": CartAddressRegion, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "parent_sku": "xyz789", + "variant_sku": "abc123" } ``` -### CartAddressRegion +### ConfigurableProductOption -Contains details about the region in a billing or shipping address. +Contains details about configurable product options. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The state or province code. | -| `label` - [`String`](#string) | The display label for the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](#string) | The display name of the option. | +| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | +| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example ```json { - "code": "abc123", - "label": "xyz789", - "region_id": 987 + "attribute_code": "xyz789", + "label": "abc123", + "uid": "4", + "values": [ConfigurableProductOptionValue] } ``` -### CartDiscount +### ConfigurableProductOptionValue -Contains information about discounts applied to the cart. +Defines a value for a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount applied to the item. | -| `label` - [`[String]!`](#string) | The description of the discount. | +| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](#id) | The unique ID of the value. | #### Example ```json { - "amount": Money, - "label": ["xyz789"] + "is_available": true, + "is_use_default": false, + "label": "xyz789", + "swatch": SwatchDataInterface, + "uid": 4 } ``` -### CartDiscountType +### ConfigurableProductOptions -#### Values +Defines configurable attributes for the specified product. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `ITEM` | | -| `SHIPPING` | | +| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | +| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | +| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | +| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | +| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | +| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | #### Example ```json -""ITEM"" +{ + "attribute_code": "xyz789", + "attribute_id": "abc123", + "attribute_id_v2": 123, + "attribute_uid": 4, + "id": 123, + "label": "xyz789", + "position": 123, + "product_id": 123, + "uid": 4, + "use_default": false, + "values": [ConfigurableProductOptionsValues] +} ``` -### CartItemError +### ConfigurableProductOptionsSelection + +Contains metadata corresponding to the selected configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | +| `variant` - [`SimpleProduct`](#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 ```json -{"code": "UNDEFINED", "message": "xyz789"} -``` - - - -### CartItemErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `ITEM_QTY` | | -| `ITEM_INCREMENTS` | | - -#### Example - -```json -""UNDEFINED"" +{ + "configurable_options": [ConfigurableProductOption], + "media_gallery": [MediaGalleryInterface], + "options_available_for_selection": [ + ConfigurableOptionAvailableForSelection + ], + "variant": SimpleProduct +} ``` -### CartItemInput +### ConfigurableProductOptionsValues -Defines an item to be added to the cart. +Contains the index number assigned to a configurable product option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | +| Field Name | Description | +|------------|-------------| +| `default_label` - [`String`](#string) | The label of the product on the default store. | +| `label` - [`String`](#string) | The label of the product. | +| `store_label` - [`String`](#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | #### Example ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", - "quantity": 987.65, - "selected_options": ["4"], - "sku": "xyz789" + "default_label": "xyz789", + "label": "abc123", + "store_label": "xyz789", + "swatch_data": SwatchDataInterface, + "uid": "4", + "use_default_value": true, + "value_index": 987 } ``` -### CartItemInterface +### ConfigurableRequisitionListItem -An interface for products in a cart. +Contains details about configurable products added to a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Possible Types - -| CartItemInterface Types | -|----------------| -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | -| [`ConfigurableCartItem`](#configurablecartitem) | -| [`DownloadableCartItem`](#downloadablecartitem) | -| [`BundleCartItem`](#bundlecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json { - "discount": [Discount], - "errors": [CartItemError], - "id": "abc123", - "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, + "configurable_options": [SelectedConfigurableOption], + "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": "4" } ``` -### CartItemPrices +### ConfigurableVariant -Contains details about the price of the item, including taxes and discounts. +Contains all the simple product variants of a configurable product. #### Fields | Field Name | Description | |------------|-------------| -| `catalog_discount` - [`ProductDiscount`](#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | -| `original_item_price` - [`Money!`](#money) | The value of the original unit price for the item, including discounts. | -| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | -| `price` - [`Money!`](#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!`](#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`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | +| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | +| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | #### Example ```json { - "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 + "attributes": [ConfigurableAttributeOption], + "product": SimpleProduct } ``` -### CartItemQuantity +### ConfigurableWishlistItem -Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`. +A configurable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `cart_item_id` - [`Int!`](#int) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | -| `quantity` - [`Float!`](#float) | *(Deprecated: The `ShippingCartAddress.cart_items` field now returns `CartItemInterface`.)* | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json -{"cart_item_id": 987, "quantity": 987.65} +{ + "added_at": "xyz789", + "child_sku": "xyz789", + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 +} ``` -### CartItemSelectedOptionValuePrice - -Contains details about the price of a selected customizable value. +### ConfirmCancelOrderInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](#float) | A price value. | +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | #### Example ```json { - "type": "FIXED", - "units": "abc123", - "value": 123.45 + "confirmation_key": "abc123", + "order_id": "4" } ``` -### CartItemUpdateInput +### ConfirmEmailInput -A single item to be updated. +Contains details about a customer email address to confirm. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | +| `email` - [`String!`](#string) | The email address to be confirmed. | #### Example ```json { - "cart_item_id": 123, - "cart_item_uid": 4, - "customizable_options": [CustomizableOptionInput], - "gift_message": GiftMessageInput, - "gift_wrapping_id": 4, - "quantity": 987.65 + "confirmation_key": "abc123", + "email": "abc123" } ``` -### CartItems +### ConfirmReturnInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned cart items. | +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | #### Example ```json { - "items": [CartItemInterface], - "page_info": SearchResultPageInfo, - "total_count": 123 + "confirmation_key": "abc123", + "order_id": 4 } ``` -### CartPrices +### ConfirmationStatusEnum -Contains details about the final price of items in the cart, including discount and tax information. +List of account confirmation statuses. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `discount` - [`CartDiscount`](#cartdiscount) | *(Deprecated: Use discounts instead.)* | -| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | -| `grand_total_excluding_tax` - [`Money`](#money) | The total of the cart, including discounts, shipping, and other fees without tax. | -| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | +| `ACCOUNT_CONFIRMED` | Account confirmed | +| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | #### Example ```json -{ - "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 -} +""ACCOUNT_CONFIRMED"" ``` -### CartRuleStorefront +### ContactUsInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CartRule` object. | +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](#string) | The email address of the shopper. | +| `name` - [`String!`](#string) | The full name of the shopper. | +| `telephone` - [`String`](#string) | The shopper's telephone number. | #### Example ```json -{"uid": "4"} +{ + "comment": "xyz789", + "email": "abc123", + "name": "xyz789", + "telephone": "abc123" +} ``` -### CartTaxItem +### ContactUsOutput -Contains tax information about an item in the cart. +Contains the status of the request. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | #### Example ```json -{ - "amount": Money, - "label": "abc123" -} +{"status": true} ``` -### CartUserInputError +### CopyItemsBetweenRequisitionListsInput -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" -} -``` - - - -### CartUserInputErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `COULD_NOT_FIND_CART_ITEM` | | -| `REQUIRED_PARAMETER_MISSING` | | -| `INVALID_PARAMETER_VALUE` | | -| `UNDEFINED` | | -| `PERMISSION_DENIED` | | - -#### Example - -```json -""PRODUCT_NOT_FOUND"" -``` - - - -### CatalogAttributeApplyToEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SIMPLE` | | -| `VIRTUAL` | | -| `BUNDLE` | | -| `DOWNLOADABLE` | | -| `CONFIGURABLE` | | -| `GROUPED` | | -| `CATEGORY` | | - -#### Example - -```json -""SIMPLE"" -``` - - - -### CatalogAttributeMetadata - -Swatch attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | - -#### Example - -```json -{ - "apply_to": ["SIMPLE"], - "code": 4, - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "is_comparable": true, - "is_filterable": true, - "is_filterable_in_search": false, - "is_html_allowed_on_front": true, - "is_required": true, - "is_searchable": false, - "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": false, - "label": "abc123", - "options": [CustomAttributeOptionInterface], - "swatch_input_type": "BOOLEAN", - "update_product_preview_image": false, - "use_product_image_for_swatch": true, - "used_in_product_listing": false -} -``` - - - -### CategoryFilterInput - -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. +An input object that defines the items in a requisition list to be copied. #### Input Fields | Input Field | Description | |-------------|-------------| -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique category ID for a `CategoryInterface` object. | -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use 'category_uid' to filter uniquely identifiers of categories. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the category. | -| `parent_category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `parent_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the unique parent category ID for a `CategoryInterface` object. | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the part of the URL that identifies the category. | -| `url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the URL path for the category. | +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -{ - "category_uid": FilterEqualTypeInput, - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput, - "parent_category_uid": FilterEqualTypeInput, - "parent_id": FilterEqualTypeInput, - "url_key": FilterEqualTypeInput, - "url_path": FilterEqualTypeInput -} +{"requisitionListItemUids": ["4"]} ``` -### CategoryInterface +### CopyItemsFromRequisitionListsOutput -Contains the full set of attributes that can be returned in a category search. +Output of the request to copy items to the destination requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | - -#### Possible Types - -| CategoryInterface Types | -|----------------| -| [`CategoryTree`](#categorytree) | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | #### Example ```json -{ - "automatic_sorting": "abc123", - "available_sort_by": ["xyz789"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "xyz789", - "cms_block": CmsBlock, - "created_at": "xyz789", - "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", - "description": "xyz789", - "display_mode": "xyz789", - "filter_price_range": 987.65, - "id": 123, - "image": "abc123", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 987, - "level": 987, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "name": "xyz789", - "path": "abc123", - "path_in_store": "abc123", - "position": 987, - "product_count": 123, - "products": CategoryProducts, - "staged": false, - "uid": "4", - "updated_at": "xyz789", - "url_key": "xyz789", - "url_path": "abc123", - "url_suffix": "xyz789" -} +{"requisition_list": RequisitionList} ``` -### CategoryProducts +### CopyProductsBetweenWishlistsOutput -Contains details about the products assigned to a category. +Contains the source and target wish lists after copying products. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that are assigned to the category. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#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. | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example ```json { - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "total_count": 123 + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] } ``` -### CategoryResult - -Contains a collection of `CategoryTree` objects and pagination information. +### Country #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CategoryTree]`](#categorytree) | A list of categories that match the filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the `page_info` and `currentPage` values specified in the query. | -| `total_count` - [`Int`](#int) | The total number of categories that match the criteria. | +| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](#string) | The name of the country in English. | +| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | +| `id` - [`String`](#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json { - "items": [CategoryTree], - "page_info": SearchResultPageInfo, - "total_count": 987 + "available_regions": [Region], + "full_name_english": "abc123", + "full_name_locale": "abc123", + "id": "xyz789", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "xyz789" } ``` -### CategoryTree +### CountryCodeEnum -Contains the hierarchy of categories. +The list of country codes. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `automatic_sorting` - [`String`](#string) | | -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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]`](#categorytree) | A tree of child categories. | -| `children_count` - [`String`](#string) | | -| `cms_block` - [`CmsBlock`](#cmsblock) | Contains a category CMS block. | -| `created_at` - [`String`](#string) | The timestamp indicating when the category was created. *(Deprecated: The field should not be used on the storefront.)* | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `id` - [`Int`](#int) | An ID that uniquely identifies the category. *(Deprecated: Use `uid` instead.)* | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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`](#categoryproducts) | The list of products assigned to the category. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the category is staged for a future campaign. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `updated_at` - [`String`](#string) | The timestamp indicating when the category was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | -| `url_suffix` - [`String`](#string) | The part of the category URL that is appended after the url key | +| `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 ```json -{ - "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": "xyz789", - "default_sort_by": "xyz789", - "description": "xyz789", - "display_mode": "abc123", - "filter_price_range": 123.45, - "id": 987, - "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 123, - "level": 987, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "xyz789", - "path": "abc123", - "path_in_store": "abc123", - "position": 987, - "product_count": 987, - "products": CategoryProducts, - "redirect_code": 987, - "relative_url": "xyz789", - "staged": false, - "type": "CMS_PAGE", - "uid": "4", - "updated_at": "xyz789", - "url_key": "xyz789", - "url_path": "xyz789", - "url_suffix": "xyz789" -} +""AF"" ``` -### CheckoutAgreement +### CreateCompanyOutput -Defines details about an individual checkout agreement. +Contains the response to the request to create a company. #### Fields | Field Name | Description | |------------|-------------| -| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](#string) | Required. The text of the agreement. | -| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | -| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](#string) | The name given to the condition. | +| `company` - [`Company!`](#company) | The new company instance. | #### Example ```json -{ - "agreement_id": 123, - "checkbox_text": "xyz789", - "content": "xyz789", - "content_height": "abc123", - "is_html": false, - "mode": "AUTO", - "name": "xyz789" -} +{"company": Company} ``` -### CheckoutAgreementMode +### CreateCompanyRoleOutput -Indicates how agreements are accepted. +Contains the response to the request to create a company role. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `AUTO` | Conditions are automatically accepted upon checkout. | -| `MANUAL` | Shoppers must manually accept the conditions to place an order. | +| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | #### Example ```json -""AUTO"" +{"role": CompanyRole} ``` -### CheckoutUserInputError +### CreateCompanyTeamOutput -An error encountered while adding an item to the cart. +Contains the response to the request to create a company team. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](#string) | A localized error message. | -| `path` - [`[String]!`](#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 | +| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | + +#### Example + +```json +{"team": CompanyTeam} +``` + + + +### CreateCompanyUserOutput + +Contains the response to the request to create a company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user` - [`Customer!`](#customer) | The new company user instance. | + +#### Example + +```json +{"user": Customer} +``` + + + +### CreateCompareListInput + +Contains an array of product IDs to use for creating a compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | + +#### Example + +```json +{"products": ["4"]} +``` + + + +### CreateGiftRegistryInput + +Defines a new gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | +| `message` - [`String!`](#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example ```json { - "code": "REORDER_NOT_AVAILABLE", - "message": "xyz789", - "path": ["abc123"] + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "abc123", + "gift_registry_type_uid": "4", + "message": "abc123", + "privacy_settings": "PRIVATE", + "registrants": [AddGiftRegistryRegistrantInput], + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" } ``` -### CheckoutUserInputErrorCodes +### CreateGiftRegistryOutput -#### Values +Contains the results of a request to create a gift registry. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `REORDER_NOT_AVAILABLE` | | -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | #### Example ```json -""REORDER_NOT_AVAILABLE"" +{"gift_registry": GiftRegistry} +``` + + + +### CreateGuestCartInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_uid` - [`ID`](#id) | Optional client-generated ID | + +#### Example + +```json +{"cart_uid": 4} +``` + + + +### CreateGuestCartOutput + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The newly created cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### CreatePayflowProTokenOutput + +Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | +| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | +| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | +| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | +| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | + +#### Example + +```json +{ + "response_message": "abc123", + "result": 987, + "result_code": 123, + "secure_token": "xyz789", + "secure_token_id": "abc123" +} ``` -### ClearCartError +### CreatePaymentOrderInput -Contains details about errors encountered when a customer clear cart. +Contains payment order details that are used while processing the payment order -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | A localized error message | -| `type` - [`ClearCartErrorType!`](#clearcarterrortype) | A cart-specific error type. | +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{ + "cartId": "xyz789", + "location": "PRODUCT_DETAIL", + "methodCode": "xyz789", + "paymentSource": "xyz789", + "vaultIntent": false +} ``` -### ClearCartErrorType +### CreatePaymentOrderOutput -#### Values +Contains payment order details that are used while processing the payment order -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `NOT_FOUND` | | -| `UNAUTHORISED` | | -| `INACTIVE` | | -| `UNDEFINED` | | +| `amount` - [`Float`](#float) | The amount of the payment order | +| `currency_code` - [`String`](#string) | The currency of the payment order | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json -""NOT_FOUND"" +{ + "amount": 987.65, + "currency_code": "xyz789", + "id": "abc123", + "mp_order_id": "abc123", + "status": "abc123" +} ``` -### ClearCartInput +### CreateProductReviewInput -Assigns a specific `cart_id` to the empty cart. +Defines a new product review. #### Input Fields | Input Field | Description | |-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID of a `Cart` object. | +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | +| `sku` - [`String!`](#string) | The SKU of the reviewed product. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json -{"uid": "4"} +{ + "nickname": "abc123", + "ratings": [ProductReviewRatingInput], + "sku": "xyz789", + "summary": "xyz789", + "text": "abc123" +} ``` -### ClearCartOutput +### CreateProductReviewOutput -Output of the request to clear the customer cart. +Contains the completed product review. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clear cart items. | -| `errors` - [`[ClearCartError]`](#clearcarterror) | An array of errors encountered while clearing the cart item | +| `review` - [`ProductReview!`](#productreview) | Product review details. | #### Example ```json -{ - "cart": Cart, - "errors": [ClearCartError] -} +{"review": ProductReview} ``` -### ClearCustomerCartOutput +### CreatePurchaseOrderApprovalRuleConditionAmountInput -Output of the request to clear the customer cart. +Specifies the amount and currency to evaluate. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | +| Input Field | Description | +|-------------|-------------| +| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | +| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | #### Example ```json -{"cart": Cart, "status": false} +{"currency": "AFN", "value": 987.65} ``` -### CloseNegotiableQuoteError +### CreatePurchaseOrderApprovalRuleConditionInput -#### Types +Defines a set of conditions that apply to a rule. -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example ```json -NegotiableQuoteInvalidStateError +{ + "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN", + "quantity": 123 +} ``` -### CloseNegotiableQuoteOperationFailure +### CreateRequisitionListInput -Contains details about a failed close operation on a negotiable quote. +An input object that identifies and describes a new requisition list. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the requisition list. | +| `name` - [`String!`](#string) | The name assigned to the requisition list. | #### Example ```json { - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "description": "xyz789", + "name": "xyz789" } ``` -### CloseNegotiableQuoteOperationResult +### CreateRequisitionListOutput -#### Types +Output of the request to create a requisition list. -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | #### Example ```json -NegotiableQuoteUidOperationSuccess +{"requisition_list": RequisitionList} ``` -### CloseNegotiableQuotesInput +### CreateVaultCardPaymentTokenInput -Defines the negotiable quotes to mark as closed. +Describe the variables needed to create a vault payment token #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| `card_description` - [`String`](#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json -{"quote_uids": [4]} +{ + "card_description": "abc123", + "setup_token_id": "abc123" +} ``` -### CloseNegotiableQuotesOutput +### CreateVaultCardPaymentTokenOutput -Contains the closed negotiable quotes and other negotiable quotes the company user can view. +The vault token id and information about the payment source #### Fields | Field Name | Description | |------------|-------------| -| `closed_quotes` - [`[NegotiableQuote]`](#negotiablequote) | An array containing the negotiable quotes that were just closed. *(Deprecated: Use `operation_results` instead.)* | -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | -| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](#string) | The vault payment token information | #### Example ```json { - "closed_quotes": [NegotiableQuote], - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" + "payment_source": PaymentSourceOutput, + "vault_token_id": "abc123" } ``` -### CmsBlock +### CreateVaultCardSetupTokenInput -Contains details about a specific CMS block. +Describe the variables needed to create a vault card setup token -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `content` - [`String`](#string) | The content of the CMS block in raw HTML. | -| `identifier` - [`String`](#string) | The CMS block identifier. | -| `title` - [`String`](#string) | The title assigned to the CMS block. | +| Input Field | Description | +|-------------|-------------| +| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | #### Example ```json { - "content": "abc123", - "identifier": "abc123", - "title": "abc123" + "setup_token": VaultSetupTokenInput, + "three_ds_mode": "OFF" } ``` -### CmsBlocks +### CreateVaultCardSetupTokenOutput -Contains an array CMS block items. +The setup token id information #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CmsBlock]`](#cmsblock) | An array of CMS blocks. | +| `setup_token` - [`String!`](#string) | The setup token id | #### Example ```json -{"items": [CmsBlock]} +{"setup_token": "xyz789"} ``` -### CmsPage - -Contains details about a CMS page. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `content` - [`String`](#string) | The content of the CMS page in raw HTML. | -| `content_heading` - [`String`](#string) | The heading that displays at the top of the CMS page. | -| `identifier` - [`String`](#string) | The ID of a CMS page. | -| `meta_description` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_keywords` - [`String`](#string) | A brief description of the page for search results listings. | -| `meta_title` - [`String`](#string) | A page title that is indexed by search engines and appears in search results listings. | -| `page_layout` - [`String`](#string) | The design layout of the page, indicating the number of columns and navigation features used on the page. | -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `title` - [`String`](#string) | The name that appears in the breadcrumb trail navigation and in the browser title bar and tab. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `url_key` - [`String`](#string) | The URL key of the CMS page, which is often based on the `content_heading`. | - -#### Example - -```json -{ - "content": "xyz789", - "content_heading": "xyz789", - "identifier": "abc123", - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "xyz789", - "page_layout": "xyz789", - "redirect_code": 987, - "relative_url": "abc123", - "title": "abc123", - "type": "CMS_PAGE", - "url_key": "xyz789" -} -``` - - +### CreateWishlistInput -### ColorSwatchData +Defines the name and visibility of a new wish list. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | #### Example ```json -{"value": "xyz789"} +{"name": "abc123", "visibility": "PUBLIC"} ``` -### CompaniesSortFieldEnum +### CreateWishlistOutput -The fields available for sorting the customer companies. +Contains the wish list. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `NAME` | The name of the company. | +| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | #### Example ```json -""NAME"" +{"wishlist": Wishlist} ``` -### CompaniesSortInput +### CreditCardDetailsInput -Specifies which field to sort on, and whether to return the results in ascending or descending order. +Required fields for Payflow Pro and Payments Pro credit card payments. #### Input Fields | Input Field | Description | |-------------|-------------| -| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | +| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | +| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | +| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | +| `cc_type` - [`String!`](#string) | The credit card type. | #### Example ```json -{"field": "NAME", "order": "ASC"} +{ + "cc_exp_month": 123, + "cc_exp_year": 123, + "cc_last_4": 123, + "cc_type": "xyz789" +} ``` -### Company +### CreditMemo -Contains the output schema for a company. +Contains credit memo details. #### Fields | Field Name | Description | |------------|-------------| -| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | -| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | -| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | -| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | -| `email` - [`String`](#string) | The email address of the company contact. | -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | -| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | -| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | -| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | -| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | -| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | -| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | +| `number` - [`String!`](#string) | The sequential credit memo number. | +| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example ```json { - "acl_resources": [CompanyAclResource], - "company_admin": Customer, - "credit": CompanyCredit, - "credit_history": CompanyCreditHistory, - "email": "xyz789", + "comments": [SalesCommentItem], "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": "xyz789" + "items": [CreditMemoItemInterface], + "number": "abc123", + "total": CreditMemoTotal } ``` -### CompanyAclResource - -Contains details about the access control list settings of a resource. +### CreditMemoItem #### Fields | Field Name | Description | |------------|-------------| -| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | -| `text` - [`String`](#string) | The label assigned to the ACL resource. | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json { - "children": [CompanyAclResource], + "discounts": [Discount], "id": 4, - "sort_order": 123, - "text": "abc123" + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` -### CompanyAdminInput +### CreditMemoItemInterface -Defines the input schema for creating a company administrator. +Credit memo item details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The company administrator's custom attributes. | -| `email` - [`String!`](#string) | The email address of the company administrator. | -| `firstname` - [`String!`](#string) | The company administrator's first name. | -| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](#string) | The job title of the company administrator. | -| `lastname` - [`String!`](#string) | The company administrator's last name. | -| `telephone` - [`String`](#string) | The phone number of the company administrator. | +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Possible Types + +| CreditMemoItemInterface Types | +|----------------| +| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | +| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| [`CreditMemoItem`](#creditmemoitem) | #### Example ```json { - "custom_attributes": [AttributeValueInput], - "email": "abc123", - "firstname": "xyz789", - "gender": 987, - "job_title": "abc123", - "lastname": "xyz789", - "telephone": "xyz789" + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` -### CompanyBasicInfo +### CreditMemoTotal -The minimal required information to identify and display the company. +Contains credit memo price details. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | +| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | #### Example ```json { - "id": 4, - "legal_name": "xyz789", - "name": "abc123", - "status": "PENDING" + "adjustment": Money, + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money } ``` -### CompanyCreateInput - -Defines the input schema for creating a new company. +### Currency -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](#string) | The email address of the company contact. | -| `company_name` - [`String!`](#string) | The name of the company to create. | -| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | +| `default_display_currecy_code` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currecy_symbol` - [`String`](#string) | *(Deprecated: Symbol was missed. Use `default_display_currency_code`.)* | +| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | +| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | #### Example ```json { - "company_admin": CompanyAdminInput, - "company_email": "abc123", - "company_name": "xyz789", - "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", - "reseller_id": "abc123", - "vat_tax_id": "abc123" + "available_currency_codes": ["abc123"], + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", + "default_display_currecy_code": "abc123", + "default_display_currecy_symbol": "xyz789", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "abc123", + "exchange_rates": [ExchangeRate] } ``` -### CompanyCredit +### CurrencyEnum -Contains company credit balances and limits. +The list of available currency codes. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | -| `outstanding_balance` - [`Money!`](#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 +| `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 + +```json +""AFN"" +``` + + + +### CustomAttributeMetadata + +Defines an array of custom attributes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Attribute]`](#attribute) | An array of attributes. | + +#### Example ```json -{ - "available_credit": Money, - "credit_limit": Money, - "outstanding_balance": Money -} +{"items": [Attribute]} ``` -### CompanyCreditHistory +### CustomAttributeMetadataInterface -Contains details about prior company credit operations. +An interface containing fields that define the EAV attribute. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | + +#### Possible Types + +| CustomAttributeMetadataInterface Types | +|----------------| +| [`AttributeMetadata`](#attributemetadata) | +| [`CatalogAttributeMetadata`](#catalogattributemetadata) | +| [`CustomerAttributeMetadata`](#customerattributemetadata) | +| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | #### Example ```json { - "items": [CompanyCreditOperation], - "page_info": SearchResultPageInfo, - "total_count": 987 + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "is_required": false, + "is_unique": true, + "label": "abc123", + "options": [CustomAttributeOptionInterface] } ``` -### CompanyCreditHistoryFilterInput +### CustomAttributeOptionInterface -Defines a filter for narrowing the results of a credit history search. +#### Fields -#### Input Fields +| Field Name | Description | +|------------|-------------| +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | -| Input Field | Description | -|-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | +#### Possible Types + +| CustomAttributeOptionInterface Types | +|----------------| +| [`AttributeOptionMetadata`](#attributeoptionmetadata) | #### Example ```json { - "custom_reference_number": "xyz789", - "operation_type": "ALLOCATION", - "updated_by": "xyz789" + "is_default": false, + "label": "xyz789", + "value": "xyz789" } ``` -### CompanyCreditOperation +### Customer -Contains details about a single company credit operation. +Defines the customer name, addresses, and other details. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | -| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](#string) | The date the operation occurred. | -| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | +| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | +| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | +| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | +| `dob` - [`String`](#string) | The customer's date of birth. *(Deprecated: Use `date_of_birth` instead.)* | +| `email` - [`String`](#string) | The customer's email address. Required. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | +| `group` - [`CustomerGroupStorefront`](#customergroupstorefront) | Customer group assigned to the customer | +| `group_id` - [`Int`](#int) | *(Deprecated: Customer group should not be exposed in the storefront scenarios.)* | +| `id` - [`ID!`](#id) | The unique ID assigned to the customer. | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `orders` - [`CustomerOrders`](#customerorders) | | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | +| `reviews` - [`ProductReviews!`](#productreviews) | Contains the customer's product reviews. | +| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | +| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | +| `segments` - [`[CustomerSegmentStorefront]`](#customersegmentstorefront) | Customer segments associated with the current customer | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | +| `telephone` - [`String`](#string) | The phone number of the company user. | +| `wishlist` - [`Wishlist!`](#wishlist) | Return a customer's wish lists. *(Deprecated: Use `Customer.wishlists` or `Customer.wishlist_v2` instead.)* | +| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](#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. | #### Example ```json { - "amount": Money, - "balance": CompanyCredit, - "custom_reference_number": "xyz789", - "date": "xyz789", - "type": "ALLOCATION", - "updated_by": CompanyCreditOperationUser + "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": "abc123", + "dob": "xyz789", + "email": "abc123", + "firstname": "xyz789", + "gender": 987, + "gift_registries": [GiftRegistry], + "gift_registry": GiftRegistry, + "group": CustomerGroupStorefront, + "group_id": 987, + "id": "4", + "is_subscribed": true, + "job_title": "xyz789", + "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": "abc123", + "taxvat": "abc123", + "team": CompanyTeam, + "telephone": "xyz789", + "wishlist": Wishlist, + "wishlist_v2": Wishlist, + "wishlists": [Wishlist] } ``` -### CompanyCreditOperationType +### CustomerAddress -#### Values +Contains detailed information about a customer's billing or shipping address. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `ALLOCATION` | | -| `UPDATE` | | -| `PURCHASE` | | -| `REIMBURSEMENT` | | -| `REFUND` | | -| `REVERT` | | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `country_id` - [`String`](#string) | The customer's country. *(Deprecated: Use `country_code` instead.)* | +| `custom_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | *(Deprecated: Use custom_attributesV2 instead.)* | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `customer_id` - [`Int`](#int) | The customer ID *(Deprecated: `customer_id` is not needed as part of `CustomerAddress`. The `id` is a unique identifier for the addresses.)* | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | +| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | +| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `uid` - [`ID`](#id) | The unique ID for a `CustomerAddress` object. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json -""ALLOCATION"" +{ + "city": "xyz789", + "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": "xyz789", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CustomerAddressRegion, + "region_id": 123, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", + "uid": "4", + "vat_id": "abc123" +} ``` -### CompanyCreditOperationUser +### CustomerAddressAttribute -Defines the administrator or company user that submitted a company credit operation. +Specifies the attribute code and value of a customer address attribute. #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | -| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | +| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](#string) | The value assigned to the customer address attribute. | #### Example ```json -{"name": "abc123", "type": "CUSTOMER"} +{ + "attribute_code": "abc123", + "value": "abc123" +} ``` -### CompanyCreditOperationUserType +### CustomerAddressAttributeInput -#### Values +Specifies the attribute code and value of a customer attribute. -| Enum Value | Description | -|------------|-------------| -| `CUSTOMER` | | -| `ADMIN` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The name assigned to the attribute. | +| `value` - [`String!`](#string) | The value assigned to the attribute. | #### Example ```json -""CUSTOMER"" +{ + "attribute_code": "xyz789", + "value": "xyz789" +} ``` -### CompanyInvitationInput +### CustomerAddressInput -Defines the input schema for accepting the company invitation. +Contains details about a billing or shipping address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | -| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | | +| `custom_attributes` - [`[CustomerAddressAttributeInput]`](#customeraddressattributeinput) | | +| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "code": "xyz789", - "role_id": 4, - "user": CompanyInvitationUserInput + "city": "xyz789", + "company": "abc123", + "country_code": "AF", + "country_id": "AF", + "custom_attributes": [CustomerAddressAttributeInput], + "custom_attributesV2": [AttributeValueInput], + "default_billing": true, + "default_shipping": true, + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": CustomerAddressRegionInput, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" } ``` -### CompanyInvitationOutput +### CustomerAddressRegion -The result of accepting the company invitation. +Defines the customer's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json -{"success": false} +{ + "region": "abc123", + "region_code": "abc123", + "region_id": 123 +} ``` -### CompanyInvitationUserInput +### CustomerAddressRegionInput -Company user attributes in the invitation. +Defines the customer's state or province. #### Input Fields | Input Field | Description | |-------------|-------------| -| `company_id` - [`ID!`](#id) | The company unique identifier. | -| `customer_id` - [`ID!`](#id) | The customer unique identifier. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The phone number of the company user. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "company_id": "4", - "customer_id": 4, - "job_title": "xyz789", - "status": "ACTIVE", - "telephone": "xyz789" + "region": "abc123", + "region_code": "xyz789", + "region_id": 987 } ``` -### CompanyLegalAddress - -Contains details about the address where the company is registered to conduct business. +### CustomerAddresses #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | -| `postcode` - [`String`](#string) | The company's postal code. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](#string) | The company's phone number. | +| `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer addresses. | #### Example ```json { - "city": "abc123", - "country_code": "AF", - "postcode": "abc123", - "region": CustomerAddressRegion, - "street": ["abc123"], - "telephone": "abc123" + "items": [CustomerAddress], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### CompanyLegalAddressCreateInput +### CustomerAttributeMetadata -Defines the input schema for defining a company's legal address. +Customer attribute metadata. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | -| `postcode` - [`String!`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](#string) | The primary phone number of the company. | +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "city": "abc123", - "country_id": "AF", - "postcode": "abc123", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "abc123" + "code": "4", + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": false, + "is_unique": false, + "label": "xyz789", + "multiline_count": 987, + "options": [CustomAttributeOptionInterface], + "sort_order": 123, + "validate_rules": [ValidationRule] } ``` -### CompanyLegalAddressUpdateInput +### CustomerCreateInput -Defines the input schema for updating a company's legal address. +An input object for creating a customer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](#string) | The primary phone number of the company. | +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | | +| `email` - [`String!`](#string) | The customer's email address. | +| `firstname` - [`String!`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "city": "xyz789", - "country_id": "AF", - "postcode": "abc123", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "abc123" + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "abc123", + "dob": "abc123", + "email": "xyz789", + "firstname": "abc123", + "gender": 987, + "is_subscribed": false, + "lastname": "abc123", + "middlename": "xyz789", + "password": "abc123", + "prefix": "xyz789", + "suffix": "xyz789", + "taxvat": "xyz789" } ``` -### CompanyRole +### CustomerDownloadableProduct -Contails details about a single role. +Contains details about a single downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | -| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | +| `date` - [`String`](#string) | The date and time the purchase was made. | +| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "id": "4", - "name": "abc123", - "permissions": [CompanyAclResource], - "users_count": 123 + "date": "xyz789", + "download_url": "abc123", + "order_increment_id": "abc123", + "remaining_downloads": "abc123", + "status": "xyz789" } ``` -### CompanyRoleCreateInput +### CustomerDownloadableProducts -Defines the input schema for creating a company role. +Contains a list of downloadable products. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]!`](#string) | A list of resources the role can access. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | #### Example ```json -{ - "name": "xyz789", - "permissions": ["abc123"] -} +{"items": [CustomerDownloadableProduct]} ``` -### CompanyRoleUpdateInput +### CustomerGroupStorefront -Defines the input schema for updating a company role. +Data of customer group. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name of the role to update. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| Field Name | Description | +|------------|-------------| +| `uid` - [`ID!`](#id) | The unique ID for a `CustomerGroup` object. | #### Example ```json -{ - "id": 4, - "name": "xyz789", - "permissions": ["abc123"] -} +{"uid": "4"} ``` -### CompanyRoles +### CustomerInput -Contains an array of roles. +An input object that assigns or updates customer attributes. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | +| Input Field | Description | +|-------------|-------------| +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | | +| `email` - [`String`](#string) | The customer's email address. Required when creating a customer. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "items": [CompanyRole], - "page_info": SearchResultPageInfo, - "total_count": 987 + "date_of_birth": "abc123", + "dob": "abc123", + "email": "abc123", + "firstname": "xyz789", + "gender": 987, + "is_subscribed": true, + "lastname": "abc123", + "middlename": "xyz789", + "password": "xyz789", + "prefix": "abc123", + "suffix": "abc123", + "taxvat": "abc123" } ``` -### CompanySalesRepresentative +### CustomerOrder -Contains details about a company sales representative. +Contains details about each of the customer's orders. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String`](#string) | The email address of the company sales representative. | -| `firstname` - [`String`](#string) | The company sales representative's first name. | -| `lastname` - [`String`](#string) | The company sales representative's last name. | +| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | +| `created_at` - [`String`](#string) | *(Deprecated: Use the `order_date` field instead.)* | +| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | +| `customer_info` - [`OrderCustomerInfo!`](#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | +| `grand_total` - [`Float`](#float) | *(Deprecated: Use the `totals.grand_total` field instead.)* | +| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | +| `increment_id` - [`String`](#string) | *(Deprecated: Use the `id` field instead.)* | +| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | +| `number` - [`String!`](#string) | The order number. | +| `order_date` - [`String!`](#string) | The date the order was placed. | +| `order_number` - [`String!`](#string) | *(Deprecated: Use the `number` field instead.)* | +| `order_status_change_date` - [`String!`](#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](#string) | The delivery method for the order. | +| `status` - [`String!`](#string) | The current status of the order. | +| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | #### Example ```json { + "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", - "firstname": "xyz789", - "lastname": "abc123" + "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": true, + "returns": Returns, + "shipments": [OrderShipment], + "shipping_address": OrderAddress, + "shipping_method": "abc123", + "status": "xyz789", + "token": "abc123", + "total": OrderTotal } ``` -### CompanyStatusEnum +### CustomerOrderSortInput -Defines the list of company status values. +CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `PENDING` | Company is pending approval. | -| `APPROVED` | Company is approved. | -| `REJECTED` | Company is rejected. | -| `BLOCKED` | Company is blocked. | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | #### Example ```json -""PENDING"" +{"sort_direction": "ASC", "sort_field": "NUMBER"} ``` -### CompanyStructure +### CustomerOrderSortableField -Contains an array of the individual nodes that comprise the company structure. +Specifies the field to use for sorting -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | +| `NUMBER` | Sorts customer orders by number | +| `CREATED_AT` | Sorts customer orders by created_at field | #### Example ```json -{"items": [CompanyStructureItem]} +""NUMBER"" ``` -### CompanyStructureEntity +### CustomerOrders -#### Types +The collection of orders that match the conditions defined in the filter. -| Union Types | -|-------------| -| [`CompanyTeam`](#companyteam) | -| [`Customer`](#customer) | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | +| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer orders. | #### Example ```json -CompanyTeam +{ + "date_of_first_order": "abc123", + "items": [CustomerOrder], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### CompanyStructureItem +### CustomerOrdersFilterInput -Defines an individual node in the company structure. +Identifies the filter to use for filtering orders. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | +| Input Field | Description | +|-------------|-------------| +| `grand_total` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filters by order status. | #### Example ```json { - "entity": CompanyTeam, - "id": "4", - "parent_id": "4" + "grand_total": FilterRangeTypeInput, + "number": FilterStringTypeInput, + "order_date": FilterRangeTypeInput, + "status": FilterEqualTypeInput } ``` -### CompanyStructureUpdateInput +### CustomerOutput -Defines the input schema for updating the company structure. +Contains details about a newly-created or updated customer. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | +| Field Name | Description | +|------------|-------------| +| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | #### Example ```json -{ - "parent_tree_id": "4", - "tree_id": "4" -} +{"customer": Customer} ``` -### CompanyTeam +### CustomerPaymentTokens -Describes a company team. +Contains payment tokens stored in the customer's vault. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID`](#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](#string) | The display name of the team. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | #### Example ```json -{ - "description": "abc123", - "id": "4", - "name": "xyz789", - "structure_id": "4" -} +{"items": [PaymentToken]} ``` -### CompanyTeamCreateInput +### CustomerSegmentStorefront -Defines the input schema for creating a company team. +Customer segment details -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `name` - [`String!`](#string) | The display name of the team. | -| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| Field Name | Description | +|------------|-------------| +| `uid` - [`ID!`](#id) | The unique ID for a `CustomerSegment` object. | #### Example ```json -{ - "description": "abc123", - "name": "xyz789", - "target_id": "4" -} +{"uid": "4"} ``` -### CompanyTeamUpdateInput +### CustomerStoreCredit -Defines the input schema for updating a company team. +Contains store credit information with balance and history. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](#string) | The display name of the team. | +| Field Name | Description | +|------------|-------------| +| `balance_history` - [`CustomerStoreCreditHistory`](#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. | +| `current_balance` - [`Money`](#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example ```json { - "description": "abc123", - "id": "4", - "name": "abc123" + "balance_history": CustomerStoreCreditHistory, + "current_balance": Money, + "enabled": false } ``` -### CompanyUpdateInput +### CustomerStoreCreditHistory -Defines the input schema for updating a company. +Lists changes to the amount of store credit available to the customer. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_email` - [`String`](#string) | The email address of the company contact. | -| `company_name` - [`String`](#string) | The name of the company to update. | -| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of items returned. | #### Example ```json { - "company_email": "xyz789", - "company_name": "abc123", - "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "xyz789", - "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "items": [CustomerStoreCreditHistoryItem], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### CompanyUserCreateInput +### CustomerStoreCreditHistoryItem -Defines the input schema for creating a company user. +Contains store credit history information. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The company user's email address | -| `firstname` - [`String!`](#string) | The company user's first name. | -| `job_title` - [`String!`](#string) | The company user's job title or function. | -| `lastname` - [`String!`](#string) | The company user's last name. | -| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`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!`](#string) | The company user's phone number. | +| Field Name | Description | +|------------|-------------| +| `action` - [`String`](#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | #### Example ```json { - "email": "xyz789", - "firstname": "xyz789", - "job_title": "abc123", - "lastname": "abc123", - "role_id": "4", - "status": "ACTIVE", - "target_id": 4, - "telephone": "xyz789" + "action": "xyz789", + "actual_balance": Money, + "balance_change": Money, + "date_time_changed": "abc123" } ``` -### CompanyUserStatusEnum +### CustomerToken -Defines the list of company user status values. +Contains a customer authorization token. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACTIVE` | Only active users. | -| `INACTIVE` | Only inactive users. | +| `token` - [`String`](#string) | The customer authorization token. | #### Example ```json -""ACTIVE"" +{"token": "xyz789"} ``` -### CompanyUserUpdateInput +### CustomerUpdateInput -Defines the input schema for updating a company user. +An input object for updating a customer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String`](#string) | The company user's email address. | -| `firstname` - [`String`](#string) | The company user's first name. | -| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](#string) | The company user's job title or function. | -| `lastname` - [`String`](#string) | The company user's last name. | -| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The company user's phone number. | +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `dob` - [`String`](#string) | | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "email": "abc123", - "firstname": "abc123", - "id": 4, - "job_title": "abc123", - "lastname": "abc123", - "role_id": "4", - "status": "ACTIVE", - "telephone": "xyz789" + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "xyz789", + "dob": "abc123", + "firstname": "xyz789", + "gender": 123, + "is_subscribed": true, + "lastname": "xyz789", + "middlename": "abc123", + "prefix": "xyz789", + "suffix": "xyz789", + "taxvat": "abc123" } ``` -### CompanyUsers +### CustomizableAreaOption -Contains details about company users. +Contains information about a text area that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The number of objects returned. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "items": [Customer], - "page_info": SearchResultPageInfo, - "total_count": 123 + "option_id": 123, + "product_sku": "xyz789", + "required": true, + "sort_order": 123, + "title": "xyz789", + "uid": 4, + "value": CustomizableAreaValue } ``` -### CompanyUsersFilterInput - -Defines the filter for returning a list of company users. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | - -#### Example - -```json -{"status": "ACTIVE"} -``` - - - -### ComparableAttribute +### CustomizableAreaValue -Contains an attribute code that is used for product comparisons. +Defines the price and sku of a product whose page contains a customized text area. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "code": "xyz789", - "label": "abc123" + "max_characters": 123, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "uid": "4" } ``` -### ComparableItem +### CustomizableCheckboxOption -Defines an object used to iterate through items for product comparisons. +Contains information about a set of checkbox values that are defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json { - "attributes": [ProductAttribute], - "product": ProductInterface, - "uid": 4 + "option_id": 987, + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": "4", + "value": [CustomizableCheckboxValue] } ``` -### CompareList +### CustomizableCheckboxValue -Contains iterable information such as the array of items, the count, and attributes that represent the compare list. +Defines the price and sku of a product whose page contains a customized set of checkbox values. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](#int) | The number of items in the compare list. | -| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "attributes": [ComparableAttribute], - "item_count": 987, - "items": [ComparableItem], - "uid": 4 + "option_type_id": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 123, + "title": "xyz789", + "uid": "4" } ``` -### CompleteOrderInput - -Update the quote and complete the order +### CustomizableDateOption -#### Input Fields +Contains information about a date picker that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example ```json { - "cartId": "abc123", - "id": "xyz789" + "option_id": 123, + "product_sku": "abc123", + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": 4, + "value": CustomizableDateValue } ``` -### ComplexTextValue +### CustomizableDateTypeEnum -#### Fields +Defines the customizable date type. -| Field Name | Description | +#### Values + +| Enum Value | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `DATE` | | +| `DATE_TIME` | | +| `TIME` | | #### Example ```json -{"html": "xyz789"} +""DATE"" ``` -### ConfigurableAttributeOption +### CustomizableDateValue -Contains details about a configurable product attribute option. +Defines the price and sku of a product whose page contains a customized date picker. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The ID assigned to the attribute. | -| `label` - [`String`](#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "code": "xyz789", - "label": "abc123", - "uid": "4", - "value_index": 123 + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "type": "DATE", + "uid": "4" } ``` -### ConfigurableCartItem +### CustomizableDropDownOption -An implementation for configurable product cart items. +Contains information about a drop down menu that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | #### Example ```json { - "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": 123.45, - "min_qty": 123.45, - "not_available_message": "abc123", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "uid": "4" + "option_id": 987, + "required": true, + "sort_order": 123, + "title": "xyz789", + "uid": "4", + "value": [CustomizableDropDownValue] } ``` -### ConfigurableOptionAvailableForSelection +### CustomizableDropDownValue -Describes configurable options that have been selected and can be selected as a result of the previous selections. +Defines the price and sku of a product whose page contains a customized drop down menu. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json { - "attribute_code": "xyz789", - "option_value_uids": ["4"] + "option_type_id": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": 4 } ``` -### ConfigurableOrderItem +### CustomizableFieldOption + +Contains information about a text field that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json { - "discounts": [Discount], - "eligible_for_return": true, - "entered_options": [OrderItemOption], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "4", - "parent_sku": "abc123", - "prices": OrderItemPrices, - "product": ProductInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "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" + "option_id": 987, + "product_sku": "abc123", + "required": false, + "sort_order": 123, + "title": "xyz789", + "uid": 4, + "value": CustomizableFieldValue } ``` -### ConfigurableProduct +### CustomizableFieldValue -Defines basic features of a configurable product and its simple product variants. +Defines the price and sku of a product whose page contains a customized text field. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | -| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | -| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "attribute_set_id": 123, - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "color": 987, - "configurable_options": [ConfigurableProductOptions], - "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 123, - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "abc123", - "new_from_date": "abc123", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 987.65, - "redirect_code": 123, - "related_products": [ProductInterface], - "relative_url": "abc123", - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 123.45, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "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", - "variants": [ConfigurableVariant], - "websites": [Website], - "weight": 987.65 + "max_characters": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", + "uid": "4" } ``` -### ConfigurableProductCartItemInput +### CustomizableFileOption -#### Input Fields +Contains information about a file picker that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the configurable product. | -| `parent_sku` - [`String`](#string) | The SKU of the parent configurable product. | -| `variant_sku` - [`String`](#string) | | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example ```json { - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "parent_sku": "xyz789", - "variant_sku": "xyz789" + "option_id": 987, + "product_sku": "xyz789", + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": CustomizableFileValue } ``` -### ConfigurableProductOption +### CustomizableFileValue -Contains details about configurable product options. +Defines the price and sku of a product whose page contains a customized file picker. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](#string) | The display name of the option. | -| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | -| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | +| `file_extension` - [`String`](#string) | The file extension to accept. | +| `image_size_x` - [`Int`](#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](#int) | The maximum height of an image. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | #### Example ```json { - "attribute_code": "xyz789", - "label": "xyz789", - "uid": "4", - "values": [ConfigurableProductOptionValue] + "file_extension": "xyz789", + "image_size_x": 987, + "image_size_y": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "uid": 4 } ``` -### ConfigurableProductOptionValue +### CustomizableMultipleOption -Defines a value for a configurable product option. +Contains information about a multiselect that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](#id) | The unique ID of the value. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example ```json { - "is_available": false, - "is_use_default": true, - "label": "xyz789", - "swatch": SwatchDataInterface, - "uid": "4" + "option_id": 987, + "required": true, + "sort_order": 987, + "title": "abc123", + "uid": 4, + "value": [CustomizableMultipleValue] } ``` -### ConfigurableProductOptions +### CustomizableMultipleValue -Defines configurable attributes for the specified product. +Defines the price and sku of a product whose page contains a customized multiselect. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | -| `attribute_id` - [`String`](#string) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_id_v2` - [`Int`](#int) | The ID assigned to the attribute. *(Deprecated: Use `attribute_uid` instead.)* | -| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | -| `id` - [`Int`](#int) | The configurable option ID number assigned by the system. *(Deprecated: Use `uid` instead.)* | -| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | -| `product_id` - [`Int`](#int) | This is the same as a product's `id` field. *(Deprecated: `product_id` is not needed and can be obtained from its parent.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | -| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json { - "attribute_code": "xyz789", - "attribute_id": "abc123", - "attribute_id_v2": 123, - "attribute_uid": 4, - "id": 123, - "label": "abc123", - "position": 987, - "product_id": 123, - "uid": 4, - "use_default": true, - "values": [ConfigurableProductOptionsValues] + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": "4" } ``` -### ConfigurableProductOptionsSelection +### CustomizableOptionInput -Contains metadata corresponding to the selected configurable options. +Defines a customizable option. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | -| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | -| `variant` - [`SimpleProduct`](#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. | +| Input Field | Description | +|-------------|-------------| +| `id` - [`Int`](#int) | The customizable option ID of the product. | +| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](#string) | The string value of the option. | #### Example ```json { - "configurable_options": [ConfigurableProductOption], - "media_gallery": [MediaGalleryInterface], - "options_available_for_selection": [ - ConfigurableOptionAvailableForSelection - ], - "variant": SimpleProduct + "id": 123, + "uid": 4, + "value_string": "xyz789" } ``` -### ConfigurableProductOptionsValues +### CustomizableOptionInterface -Contains the index number assigned to a configurable product option. +Contains basic information about a customizable option. It can be implemented by several types of configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](#string) | The label of the product on the default store. | -| `label` - [`String`](#string) | The label of the product. | -| `store_label` - [`String`](#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. *(Deprecated: Use `uid` instead.)* | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | + +#### Possible Types + +| CustomizableOptionInterface Types | +|----------------| +| [`CustomizableAreaOption`](#customizableareaoption) | +| [`CustomizableDateOption`](#customizabledateoption) | +| [`CustomizableDropDownOption`](#customizabledropdownoption) | +| [`CustomizableMultipleOption`](#customizablemultipleoption) | +| [`CustomizableFieldOption`](#customizablefieldoption) | +| [`CustomizableFileOption`](#customizablefileoption) | +| [`CustomizableRadioOption`](#customizableradiooption) | +| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | #### Example ```json { - "default_label": "abc123", - "label": "xyz789", - "store_label": "xyz789", - "swatch_data": SwatchDataInterface, - "uid": "4", - "use_default_value": false, - "value_index": 987 + "option_id": 987, + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": 4 } ``` -### ConfigurableRequisitionListItem +### CustomizableProductInterface -Contains details about configurable products added to a requisition list. +Contains information about customizable product options. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | + +#### Possible Types + +| CustomizableProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | #### Example ```json -{ - "configurable_options": [SelectedConfigurableOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "uid": "4" -} +{"options": [CustomizableOptionInterface]} ``` -### ConfigurableVariant +### CustomizableRadioOption -Contains all the simple product variants of a configurable product. +Contains information about a set of radio buttons that are defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `option_id` - [`Int`](#int) | Option ID. *(Deprecated: Use `uid` instead)* | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example ```json { - "attributes": [ConfigurableAttributeOption], - "product": SimpleProduct + "option_id": 987, + "required": true, + "sort_order": 123, + "title": "xyz789", + "uid": 4, + "value": [CustomizableRadioValue] } ``` -### ConfigurableWishlistItem +### CustomizableRadioValue -A configurable product wish list item. +Defines the price and sku of a product whose page contains a customized set of radio buttons. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `child_sku` - [`String!`](#string) | The SKU of the simple product corresponding to a set of selected configurable options. *(Deprecated: Use `ConfigurableWishlistItem.configured_variant.sku` instead.)* | -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "added_at": "abc123", - "child_sku": "xyz789", - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 123.45 + "option_type_id": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "abc123", + "uid": 4 } ``` -### ConfirmCancelOrderInput +### DeleteCompanyRoleOutput -#### Input Fields +Contains the response to the request to delete the company role. -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example ```json -{ - "confirmation_key": "abc123", - "order_id": 4 -} +{"success": true} ``` -### ConfirmEmailInput +### DeleteCompanyTeamOutput -Contains details about a customer email address to confirm. +Contains the status of the request to delete a company team. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{ - "confirmation_key": "abc123", - "email": "xyz789" -} +{"success": false} ``` -### ConfirmReturnInput +### DeleteCompanyUserOutput -#### Input Fields +Contains the response to the request to delete the company user. -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{ - "confirmation_key": "xyz789", - "order_id": 4 -} +{"success": false} ``` -### ConfirmationStatusEnum +### DeleteCompareListOutput -List of account confirmation statuses. +Contains the results of the request to delete a compare list. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACCOUNT_CONFIRMED` | Account confirmed | -| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | #### Example ```json -""ACCOUNT_CONFIRMED"" +{"result": true} ``` -### ContactUsInput +### DeleteNegotiableQuoteError -#### Input Fields +#### Types -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](#string) | The email address of the shopper. | -| `name` - [`String!`](#string) | The full name of the shopper. | -| `telephone` - [`String`](#string) | The shopper's telephone number. | +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | #### Example ```json -{ - "comment": "xyz789", - "email": "abc123", - "name": "abc123", - "telephone": "abc123" -} +NegotiableQuoteInvalidStateError ``` -### ContactUsOutput +### DeleteNegotiableQuoteOperationFailure -Contains the status of the request. +Contains details about a failed delete operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"status": false} +{ + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": "4" +} ``` -### CopyItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be copied. +### DeleteNegotiableQuoteOperationResult -#### Input Fields +#### Types -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | #### Example ```json -{"requisitionListItemUids": [4]} +NegotiableQuoteUidOperationSuccess ``` -### CopyItemsFromRequisitionListsOutput +### DeleteNegotiableQuoteTemplateInput -Output of the request to copy items to the destination requisition list. +Specifies the quote template id of the quote template to delete -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"requisition_list": RequisitionList} +{"template_id": 4} ``` -### CopyProductsBetweenWishlistsOutput - -Contains the source and target wish lists after copying products. +### DeleteNegotiableQuotesInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| Input Field | Description | +|-------------|-------------| +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | #### Example ```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} +{"quote_uids": ["4"]} ``` -### Country +### DeleteNegotiableQuotesOutput + +Contains a list of undeleted negotiable quotes the company user can view. #### Fields | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](#string) | The name of the country in English. | -| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | -| `id` - [`String`](#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example ```json { - "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "xyz789", - "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" } ``` -### CountryCodeEnum - -The list of country codes. +### DeletePaymentTokenOutput -#### Values +Indicates whether the request succeeded and returns the remaining customer payment tokens. -| Enum Value | Description | -|------------|-------------| -| `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 &amp; 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 | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | #### Example ```json -""AF"" +{ + "customerPaymentTokens": CustomerPaymentTokens, + "result": false +} ``` -### CreateCompanyOutput +### DeletePurchaseOrderApprovalRuleError -Contains the response to the request to create a company. +Contains details about an error that occurred when deleting an approval rule . #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The new company instance. | +| `message` - [`String`](#string) | The text of the error message. | +| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"company": Company} +{"message": "abc123", "type": "UNDEFINED"} ``` -### CreateCompanyRoleOutput +### DeletePurchaseOrderApprovalRuleErrorType -Contains the response to the request to create a company role. +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNDEFINED` | | +| `NOT_FOUND` | | + +#### Example + +```json +""UNDEFINED"" +``` + + + +### DeletePurchaseOrderApprovalRuleInput + +Specifies the IDs of the approval rules to delete. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | + +#### Example + +```json +{"approval_rule_uids": [4]} +``` + + + +### DeletePurchaseOrderApprovalRuleOutput + +Contains any errors encountered while attempting to delete approval rules. #### Fields | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | +| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | #### Example ```json -{"role": CompanyRole} +{"errors": [DeletePurchaseOrderApprovalRuleError]} ``` -### CreateCompanyTeamOutput +### DeleteRequisitionListItemsOutput -Contains the response to the request to create a company team. +Output of the request to remove items from the requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### DeleteRequisitionListOutput + +Indicates whether the request to delete the requisition list was successful. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | + +#### Example + +```json +{"requisition_lists": RequisitionLists, "status": true} +``` + + + +### DeleteWishlistOutput + +Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | + +#### Example + +```json +{"status": false, "wishlists": [Wishlist]} +``` + + + +### Discount + +Specifies the discount type and value for quote line item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | +| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | +| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](#string) | A description of the discount. | +| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](#float) | Quote line item discount value. | + +#### Example + +```json +{ + "amount": Money, + "applied_to": "ITEM", + "coupon": AppliedCoupon, + "is_discounting_locked": true, + "label": "xyz789", + "type": "abc123", + "value": 987.65 +} +``` + + + +### DownloadableCartItem + +An implementation for downloadable product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "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": "abc123", + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "samples": [DownloadableProductSamples], + "uid": 4 +} +``` + + + +### DownloadableCreditMemoItem + +Defines downloadable product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 123.45 +} +``` + + + +### DownloadableFileTypeEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FILE` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `URL` | *(Deprecated: `sample_url` serves to get the downloadable sample)* | + +#### Example + +```json +""FILE"" +``` + + + +### DownloadableInvoiceItem + +Defines downloadable product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 987.65 +} +``` + + + +### DownloadableItemsLinks + +Defines characteristics of the links for downloadable product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | + +#### Example + +```json +{ + "sort_order": 987, + "title": "abc123", + "uid": "4" +} +``` + + + +### DownloadableOrderItem + +Defines downloadable product options for `OrderItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json -{"team": CompanyTeam} +{ + "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "prices": OrderItemPrices, + "product": ProductInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 987.65, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} ``` -### CreateCompanyUserOutput +### DownloadableProduct -Contains the response to the request to create a company user. +Defines a product that the shopper downloads. #### Fields | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The new company user instance. | - -#### Example - -```json -{"user": Customer} -``` - - - -### CreateCompareListInput - -Contains an array of product IDs to use for creating a compare list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | +| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | #### Example ```json -{"products": ["4"]} +{ + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "xyz789", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "downloadable_product_links": [ + DownloadableProductLinks + ], + "downloadable_product_samples": [ + DownloadableProductSamples + ], + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "id": 987, + "image": ProductImage, + "is_returnable": "xyz789", + "links_purchased_separately": 123, + "links_title": "xyz789", + "manufacturer": 123, + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "rating_summary": 123.45, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": false, + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "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] +} ``` -### CreateGiftRegistryInput +### DownloadableProductCartItemInput -Defines a new gift registry. +Defines a single downloadable product. #### Input Fields | Input Field | Description | |-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | -| `message` - [`String!`](#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | +| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "abc123", - "gift_registry_type_uid": "4", - "message": "xyz789", - "privacy_settings": "PRIVATE", - "registrants": [AddGiftRegistryRegistrantInput], - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "downloadable_product_links": [ + DownloadableProductLinksInput + ] } ``` -### CreateGiftRegistryOutput +### DownloadableProductLinks -Contains the results of a request to create a gift registry. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `is_shareable` - [`Boolean`](#boolean) | *(Deprecated: This information should not be exposed on frontend.)* | +| `link_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `number_of_downloads` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `price` - [`Float`](#float) | The price of the downloadable product. | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "id": 123, + "is_shareable": true, + "link_type": "FILE", + "number_of_downloads": 123, + "price": 987.65, + "sample_file": "abc123", + "sample_type": "FILE", + "sample_url": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": 4 +} ``` -### CreateGuestCartInput +### DownloadableProductLinksInput + +Contains the link ID for the downloadable product. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | - -#### Example - -```json -{"cart_uid": 4} -``` - - - -### CreateGuestCartOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The newly created cart. | +| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | #### Example ```json -{"cart": Cart} +{"link_id": 123} ``` -### CreatePayflowProTokenOutput +### DownloadableProductSamples -Contains the secure information used to authorize transaction. Applies to Payflow Pro and Payments Pro payment methods. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `response_message` - [`String!`](#string) | The RESPMSG returned by PayPal. If the `result` is `0`, then `response_message` is `Approved`. | -| `result` - [`Int!`](#int) | A non-zero value if any errors occurred. | -| `result_code` - [`Int!`](#int) | The RESULT returned by PayPal. A value of `0` indicates the transaction was approved. | -| `secure_token` - [`String!`](#string) | A secure token generated by PayPal. | -| `secure_token_id` - [`String!`](#string) | A secure token ID generated by PayPal. | +| `id` - [`Int`](#int) | *(Deprecated: This information should not be exposed on frontend.)* | +| `sample_file` - [`String`](#string) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_type` - [`DownloadableFileTypeEnum`](#downloadablefiletypeenum) | *(Deprecated: `sample_url` serves to get the downloadable sample)* | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the sample. | #### Example ```json { - "response_message": "abc123", - "result": 123, - "result_code": 987, - "secure_token": "xyz789", - "secure_token_id": "abc123" + "id": 123, + "sample_file": "xyz789", + "sample_type": "FILE", + "sample_url": "xyz789", + "sort_order": 123, + "title": "abc123" } ``` -### CreatePaymentOrderInput +### DownloadableRequisitionListItem -Contains payment order details that are used while processing the payment order +Contains details about downloadable products added to a requisition list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json { - "cartId": "xyz789", - "location": "PRODUCT_DETAIL", - "methodCode": "xyz789", - "paymentSource": "abc123", - "vaultIntent": false + "customizable_options": [SelectedCustomizableOption], + "links": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 987.65, + "samples": [DownloadableProductSamples], + "uid": "4" } ``` -### CreatePaymentOrderOutput +### DownloadableWishlistItem -Contains payment order details that are used while processing the payment order +A downloadable product wish list item. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](#float) | The amount of the payment order | -| `currency_code` - [`String`](#string) | The currency of the payment order | -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `status` - [`String`](#string) | The status of the payment order | +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | #### Example ```json { - "amount": 123.45, - "currency_code": "abc123", - "id": "xyz789", - "mp_order_id": "abc123", - "status": "abc123" + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "links_v2": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 987.65, + "samples": [DownloadableProductSamples] } ``` -### CreateProductReviewInput +### DuplicateNegotiableQuoteInput -Defines a new product review. +Identifies a quote to be duplicated #### Input Fields | Input Field | Description | |-------------|-------------| -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `ratings` - [`[ProductReviewRatingInput]!`](#productreviewratinginput) | The ratings details by category. For example, Price: 5 stars, Quality: 4 stars, etc. | -| `sku` - [`String!`](#string) | The SKU of the reviewed product. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | +| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | #### Example ```json { - "nickname": "xyz789", - "ratings": [ProductReviewRatingInput], - "sku": "abc123", - "summary": "xyz789", - "text": "abc123" + "duplicated_quote_uid": "4", + "quote_uid": "4" } ``` -### CreateProductReviewOutput +### DuplicateNegotiableQuoteOutput -Contains the completed product review. +Contains the newly created negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `review` - [`ProductReview!`](#productreview) | Product review details. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | #### Example ```json -{"review": ProductReview} +{"quote": NegotiableQuote} ``` -### CreatePurchaseOrderApprovalRuleConditionAmountInput +### DynamicBlock -Specifies the amount and currency to evaluate. +Contains a single dynamic block. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| Field Name | Description | +|------------|-------------| +| `content` - [`ComplexTextValue!`](#complextextvalue) | The renderable HTML code of the dynamic block. | +| `uid` - [`ID!`](#id) | The unique ID of a `DynamicBlock` object. | #### Example ```json -{"currency": "AFN", "value": 987.65} +{"content": ComplexTextValue, "uid": 4} ``` -### CreatePurchaseOrderApprovalRuleConditionInput +### DynamicBlockLocationEnum -Defines a set of conditions that apply to a rule. +Indicates the locations the dynamic block can be placed. If this field is not specified, the query returns all locations. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | -| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| Enum Value | Description | +|------------|-------------| +| `CONTENT` | | +| `HEADER` | | +| `FOOTER` | | +| `LEFT` | | +| `RIGHT` | | #### Example ```json -{ - "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN", - "quantity": 987 -} +""CONTENT"" ``` -### CreateRequisitionListInput +### DynamicBlockTypeEnum -An input object that identifies and describes a new requisition list. +Indicates the selected Dynamic Blocks Rotator inline widget. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| Enum Value | Description | +|------------|-------------| +| `SPECIFIED` | | +| `CART_PRICE_RULE_RELATED` | | +| `CATALOG_PRICE_RULE_RELATED` | | #### Example ```json -{ - "description": "xyz789", - "name": "abc123" -} +""SPECIFIED"" ``` -### CreateRequisitionListOutput +### DynamicBlocks -Output of the request to create a requisition list. +Contains an array of dynamic blocks. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `items` - [`[DynamicBlock]!`](#dynamicblock) | An array containing individual dynamic blocks. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned dynamic blocks. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "items": [DynamicBlock], + "page_info": SearchResultPageInfo, + "total_count": 123 +} ``` -### CreateVaultCardPaymentTokenInput +### DynamicBlocksFilterInput -Describe the variables needed to create a vault payment token +Defines the dynamic block filter. The filter can identify the block type, location and IDs to return. #### Input Fields | Input Field | Description | |-------------|-------------| -| `card_description` - [`String`](#string) | Description of the vaulted card | -| `setup_token_id` - [`String!`](#string) | The setup token obtained by the createVaultCardSetupToken endpoint | +| `dynamic_block_uids` - [`[ID]`](#id) | An array of dynamic block UIDs to filter on. | +| `locations` - [`[DynamicBlockLocationEnum]`](#dynamicblocklocationenum) | An array indicating the locations the dynamic block can be placed. | +| `type` - [`DynamicBlockTypeEnum!`](#dynamicblocktypeenum) | A value indicating the type of dynamic block to filter on. | #### Example ```json -{ - "card_description": "xyz789", - "setup_token_id": "abc123" -} +{"dynamic_block_uids": [4], "locations": ["CONTENT"], "type": "SPECIFIED"} ``` -### CreateVaultCardPaymentTokenOutput +### EnteredCustomAttributeInput -The vault token id and information about the payment source +Contains details about a custom text attribute that the buyer entered. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](#string) | The vault payment token information | +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](#string) | The text or other entered value. | #### Example ```json { - "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "attribute_code": "abc123", + "value": "xyz789" } ``` -### CreateVaultCardSetupTokenInput +### EnteredOptionInput -Describe the variables needed to create a vault card setup token +Defines a customer-entered option. #### Input Fields | Input Field | Description | |-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](#string) | Text the customer entered. | #### Example ```json { - "setup_token": VaultSetupTokenInput, - "three_ds_mode": "OFF" + "uid": "4", + "value": "xyz789" } ``` -### CreateVaultCardSetupTokenOutput +### EntityUrl -The setup token id information +Contains the `uid`, `relative_url`, and `type` attributes. #### Fields | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](#string) | The setup token id | +| `canonical_url` - [`String`](#string) | *(Deprecated: Use `relative_url` instead.)* | +| `entity_uid` - [`ID`](#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`](#int) | The ID assigned to the object associated with the specified url. This could be a product ID, category ID, or page ID. *(Deprecated: Use `entity_uid` instead.)* | +| `redirectCode` - [`Int`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | #### Example ```json -{"setup_token": "abc123"} +{ + "canonical_url": "abc123", + "entity_uid": "4", + "id": 123, + "redirectCode": 987, + "relative_url": "abc123", + "type": "CMS_PAGE" +} ``` -### CreateWishlistInput +### Error -Defines the name and visibility of a new wish list. +An error encountered while adding an item to the the cart. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | + +#### Possible Types + +| Error Types | +|----------------| +| [`CartUserInputError`](#cartuserinputerror) | +| [`InsufficientStockError`](#insufficientstockerror) | #### Example ```json -{"name": "abc123", "visibility": "PUBLIC"} +{ + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" +} ``` -### CreateWishlistOutput - -Contains the wish list. +### ErrorInterface #### Fields | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `message` - [`String!`](#string) | The returned error message. | + +#### Possible Types + +| ErrorInterface Types | +|----------------| +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | #### Example ```json -{"wishlist": Wishlist} +{"message": "abc123"} ``` -### CreditCardDetailsInput +### EstimateAddressInput -Required fields for Payflow Pro and Payments Pro credit card payments. +Contains details about an address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cc_exp_month` - [`Int!`](#int) | The credit card expiration month. | -| `cc_exp_year` - [`Int!`](#int) | The credit card expiration year. | -| `cc_last_4` - [`Int!`](#int) | The last 4 digits of the credit card. | -| `cc_type` - [`String!`](#string) | The credit card type. | +| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example ```json { - "cc_exp_month": 987, - "cc_exp_year": 123, - "cc_last_4": 123, - "cc_type": "abc123" + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput } ``` -### CreditMemo - -Contains credit memo details. +### EstimateTotalsInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | -| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](#string) | The sequential credit memo number. | -| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | +| Input Field | Description | +|-------------|-------------| +| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | +| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | #### Example ```json { - "comments": [SalesCommentItem], - "id": 4, - "items": [CreditMemoItemInterface], - "number": "xyz789", - "total": CreditMemoTotal + "address": EstimateAddressInput, + "cart_id": "abc123", + "shipping_method": ShippingMethodInput } ``` -### CreditMemoItem +### EstimateTotalsOutput + +Estimate totals output. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `cart` - [`Cart`](#cart) | Cart after totals estimation | #### Example ```json -{ - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 -} +{"cart": Cart} ``` -### CreditMemoItemInterface +### ExchangeExternalCustomerTokenInput -Credit memo item details. +Contains details about external customer. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer characteristics to update. | + +#### Example + +```json +{"customer": CustomerCreateInput} +``` + + + +### ExchangeExternalCustomerTokenOutput + +Contains customer token for external customer. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Possible Types - -| CreditMemoItemInterface Types | -|----------------| -| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | -| [`CreditMemoItem`](#creditmemoitem) | +| `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | +| `token` - [`String!`](#string) | The customer authorization token. | #### Example ```json { - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 + "customer": Customer, + "token": "abc123" } ``` -### CreditMemoTotal +### ExchangeRate -Contains credit memo price details. +Lists the exchange rate. #### Fields | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | +| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | #### Example ```json -{ - "adjustment": Money, - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} +{"currency_to": "abc123", "rate": 123.45} ``` + +### createEmptyCartInput + +Assigns a specific `cart_id` to the empty cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String`](#string) | The ID to assign to the cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md new file mode 100644 index 000000000..21204e170 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md @@ -0,0 +1,2532 @@ +## Types + +### FastlaneConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "code": "xyz789", + "is_visible": false, + "payment_intent": "xyz789", + "payment_source": "xyz789", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "three_ds_mode": "OFF", + "title": "xyz789" +} +``` + + + +### FastlaneMethodInput + +Fastlane Payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `paypal_fastlane_token` - [`String`](#string) | The single use token from Fastlane | + +#### Example + +```json +{ + "payment_source": "abc123", + "paypal_fastlane_token": "xyz789" +} +``` + + + +### FilterEqualTypeInput + +Defines a filter that matches the input exactly. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#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]`](#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 + +```json +{ + "eq": "xyz789", + "in": ["xyz789"] +} +``` + + + +### FilterMatchTypeEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FULL` | | +| `PARTIAL` | | + +#### Example + +```json +""FULL"" +``` + + + +### FilterMatchTypeInput + +Defines a filter that performs a fuzzy search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `match` - [`String`](#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`](#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 + +```json +{"match": "abc123", "match_type": "FULL"} +``` + + + +### FilterRangeTypeInput + +Defines a filter that matches a range of values, such as prices or dates. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | + +#### Example + +```json +{ + "from": "xyz789", + "to": "xyz789" +} +``` + + + +### FilterStringTypeInput + +Defines a filter for an input string. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | + +#### Example + +```json +{ + "eq": "abc123", + "in": ["xyz789"], + "match": "abc123" +} +``` + + + +### FilterTypeInput + +Defines the comparison operators that can be used in a filter. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Equals. | +| `finset` - [`[String]`](#string) | | +| `from` - [`String`](#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](#string) | Greater than. | +| `gteq` - [`String`](#string) | Greater than or equal to. | +| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](#string) | Less than. | +| `lteq` - [`String`](#string) | Less than or equal to. | +| `moreq` - [`String`](#string) | More than or equal to. | +| `neq` - [`String`](#string) | Not equal to. | +| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](#string) | Not null. | +| `null` - [`String`](#string) | Is null. | +| `to` - [`String`](#string) | To. Must be used with the `from` field. | + +#### Example + +```json +{ + "eq": "abc123", + "finset": ["xyz789"], + "from": "abc123", + "gt": "abc123", + "gteq": "abc123", + "in": ["abc123"], + "like": "abc123", + "lt": "abc123", + "lteq": "abc123", + "moreq": "xyz789", + "neq": "abc123", + "nin": ["xyz789"], + "notnull": "xyz789", + "null": "xyz789", + "to": "xyz789" +} +``` + + + +### FixedProductTax + +A single FPT that can be applied to a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | + +#### Example + +```json +{ + "amount": Money, + "label": "xyz789" +} +``` + + + +### FixedProductTaxDisplaySettings + +Lists display settings for the Fixed Product Tax. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""INCLUDE_FPT_WITHOUT_DETAILS"" +``` + + + +### Float + +The `Float` scalar type represents signed double-precision fractional +values as specified by +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). + +#### Example + +```json +123.45 +``` + + + +### GenerateCustomerTokenAsAdminInput + +Identifies which customer requires remote shopping assistance. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | + +#### Example + +```json +{"customer_email": "xyz789"} +``` + + + +### GenerateCustomerTokenAsAdminOutput + +Contains the generated customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer_token` - [`String!`](#string) | The generated customer token. | + +#### Example + +```json +{"customer_token": "xyz789"} +``` + + + +### GenerateNegotiableQuoteFromTemplateInput + +Specifies the template id, from which to generate quote from. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": 4} +``` + + + +### GenerateNegotiableQuoteFromTemplateOutput + +Contains the generated negotiable quote id. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | + +#### Example + +```json +{"negotiable_quote_uid": 4} +``` + + + +### GetPaymentSDKOutput + +Gets the payment SDK URLs and values + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | + +#### Example + +```json +{"sdkParams": [PaymentSDKParamsItem]} +``` + + + +### GiftCardAccount + +Contains details about the gift card account. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`Money`](#money) | The balance remaining on the gift card. | +| `code` - [`String`](#string) | The gift card account code. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "balance": Money, + "code": "xyz789", + "expiration_date": "abc123" +} +``` + + + +### GiftCardAccountInput + +Contains the gift card code. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_card_code` - [`String!`](#string) | The applied gift card code. | + +#### Example + +```json +{"gift_card_code": "abc123"} +``` + + + +### GiftCardAmounts + +Contains the value of a gift card, the website that generated the card, and related information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_id` - [`Int`](#int) | An internal attribute ID. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | +| `value` - [`Float`](#float) | The value of the gift card. | +| `value_id` - [`Int`](#int) | An ID that is assigned to each unique gift card amount. *(Deprecated: Use `uid` instead)* | +| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | +| `website_value` - [`Float`](#float) | The value of the gift card. | + +#### Example + +```json +{ + "attribute_id": 987, + "uid": 4, + "value": 123.45, + "value_id": 123, + "website_id": 123, + "website_value": 987.65 +} +``` + + + +### GiftCardCartItem + +Contains details about a gift card that has been added to a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender. | +| `sender_name` - [`String!`](#string) | The name of the sender. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "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": "abc123", + "min_qty": 123.45, + "not_available_message": "abc123", + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 987.65, + "recipient_email": "abc123", + "recipient_name": "abc123", + "sender_email": "abc123", + "sender_name": "abc123", + "uid": "4" +} +``` + + + +### GiftCardCreditMemoItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 +} +``` + + + +### GiftCardInvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 123.45 +} +``` + + + +### GiftCardItem + +Contains details about a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | + +#### Example + +```json +{ + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "xyz789" +} +``` + + + +### GiftCardOptions + +Contains details about the sender, recipient, and amount of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](#string) | A message to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | + +#### Example + +```json +{ + "amount": Money, + "custom_giftcard_amount": Money, + "message": "abc123", + "recipient_email": "xyz789", + "recipient_name": "xyz789", + "sender_email": "xyz789", + "sender_name": "abc123" +} +``` + + + +### GiftCardOrderItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "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": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} +``` + + + +### GiftCardProduct + +Defines properties of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | +| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | +| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "allow_message": true, + "allow_open_amount": false, + "attribute_set_id": 987, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_card_options": [CustomizableOptionInterface], + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "giftcard_amounts": [GiftCardAmounts], + "giftcard_type": "VIRTUAL", + "id": 987, + "image": ProductImage, + "is_redeemable": true, + "is_returnable": "xyz789", + "lifetime": 987, + "manufacturer": 987, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "message_max_length": 123, + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "open_amount_max": 123.45, + "open_amount_min": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 987.65, + "rating_summary": 123.45, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "xyz789", + "staged": false, + "stock_status": "IN_STOCK", + "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": "xyz789", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### GiftCardRequisitionListItem + +Contains details about gift cards added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "gift_card_options": GiftCardOptions, + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### GiftCardShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 123.45 +} +``` + + + +### GiftCardTypeEnum + +Specifies the gift card type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `VIRTUAL` | | +| `PHYSICAL` | | +| `COMBINED` | | + +#### Example + +```json +""VIRTUAL"" +``` + + + +### GiftCardWishlistItem + +A single gift card added to a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "gift_card_options": GiftCardOptions, + "id": 4, + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### GiftCartAttributeValue + +Gift card custom attribute value containing array data. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The attribute code. | +| `options` - [`[String]!`](#string) | Array of gift card attribute option values. | + +#### Example + +```json +{"code": 4, "options": ["xyz789"]} +``` + + + +### GiftMessage + +Contains the text of a gift message, its sender, and recipient + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `from` - [`String!`](#string) | Sender name | +| `message` - [`String!`](#string) | Gift message text | +| `to` - [`String!`](#string) | Recipient name | + +#### Example + +```json +{ + "from": "xyz789", + "message": "abc123", + "to": "xyz789" +} +``` + + + +### GiftMessageInput + +Defines a gift message. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String!`](#string) | The name of the sender. | +| `message` - [`String!`](#string) | The text of the gift message. | +| `to` - [`String!`](#string) | The name of the recepient. | + +#### Example + +```json +{ + "from": "xyz789", + "message": "abc123", + "to": "abc123" +} +``` + + + +### GiftOptionsPrices + +Contains prices for gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](#money) | Price for the printed card including tax. | + +#### Example + +```json +{ + "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 +} +``` + + + +### GiftRegistry + +Contains details about a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | +| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | +| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | +| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | +| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | + +#### Example + +```json +{ + "created_at": "xyz789", + "dynamic_attributes": [GiftRegistryDynamicAttribute], + "event_name": "xyz789", + "items": [GiftRegistryItemInterface], + "message": "xyz789", + "owner_name": "xyz789", + "privacy_settings": "PRIVATE", + "registrants": [GiftRegistryRegistrant], + "shipping_address": CustomerAddress, + "status": "ACTIVE", + "type": GiftRegistryType, + "uid": 4 +} +``` + + + +### GiftRegistryDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": 4, + "group": "EVENT_INFORMATION", + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### GiftRegistryDynamicAttributeGroup + +Defines the group type of a gift registry dynamic attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `EVENT_INFORMATION` | | +| `PRIVACY_SETTINGS` | | +| `REGISTRANT` | | +| `GENERAL_INFORMATION` | | +| `DETAILED_INFORMATION` | | +| `SHIPPING_ADDRESS` | | + +#### Example + +```json +""EVENT_INFORMATION"" +``` + + + +### GiftRegistryDynamicAttributeInput + +Defines a dynamic attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | +| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | + +#### Example + +```json +{ + "code": "4", + "value": "xyz789" +} +``` + + + +### GiftRegistryDynamicAttributeInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Possible Types + +| GiftRegistryDynamicAttributeInterface Types | +|----------------| +| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | +| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | + +#### Example + +```json +{ + "code": "4", + "label": "xyz789", + "value": "xyz789" +} +``` + + + +### GiftRegistryDynamicAttributeMetadata + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Example + +```json +{ + "attribute_group": "xyz789", + "code": 4, + "input_type": "xyz789", + "is_required": false, + "label": "xyz789", + "sort_order": 987 +} +``` + + + +### GiftRegistryDynamicAttributeMetadataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Possible Types + +| GiftRegistryDynamicAttributeMetadataInterface Types | +|----------------| +| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | + +#### Example + +```json +{ + "attribute_group": "abc123", + "code": 4, + "input_type": "abc123", + "is_required": true, + "label": "abc123", + "sort_order": 987 +} +``` + + + +### GiftRegistryItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Example + +```json +{ + "created_at": "xyz789", + "note": "xyz789", + "product": ProductInterface, + "quantity": 987.65, + "quantity_fulfilled": 123.45, + "uid": "4" +} +``` + + + +### GiftRegistryItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface`](#productinterface) | Details about the gift registry item. | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Possible Types + +| GiftRegistryItemInterface Types | +|----------------| +| [`GiftRegistryItem`](#giftregistryitem) | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "abc123", + "product": ProductInterface, + "quantity": 987.65, + "quantity_fulfilled": 987.65, + "uid": "4" +} +``` + + + +### GiftRegistryItemUserErrorInterface + +Contains the status and any errors that encountered with the customer's gift register item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | + +#### Possible Types + +| GiftRegistryItemUserErrorInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{ + "status": false, + "user_errors": [GiftRegistryItemsUserError] +} +``` + + + +### GiftRegistryItemsUserError + +Contains details about an error that occurred when processing a gift registry item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | +| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | +| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | +| `message` - [`String!`](#string) | A localized error message. | +| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | + +#### Example + +```json +{ + "code": "OUT_OF_STOCK", + "gift_registry_item_uid": "4", + "gift_registry_uid": "4", + "message": "abc123", + "product_uid": 4 +} +``` + + + +### GiftRegistryItemsUserErrorType + +Defines the error type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""OUT_OF_STOCK"" +``` + + + +### GiftRegistryOutputInterface + +Contains the customer's gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | + +#### Possible Types + +| GiftRegistryOutputInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### GiftRegistryPrivacySettings + +Defines the privacy setting of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRIVATE` | | +| `PUBLIC` | | + +#### Example + +```json +""PRIVATE"" +``` + + + +### GiftRegistryRegistrant + +Contains details about a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | +| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryRegistrantDynamicAttribute + ], + "email": "abc123", + "firstname": "abc123", + "lastname": "xyz789", + "uid": "4" +} +``` + + + +### GiftRegistryRegistrantDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": "4", + "label": "abc123", + "value": "abc123" +} +``` + + + +### GiftRegistrySearchResult + +Contains the results of a gift registry search. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `event_date` - [`String`](#string) | The date of the event. | +| `event_title` - [`String!`](#string) | The title given to the event. | +| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | +| `location` - [`String`](#string) | The location of the event. | +| `name` - [`String!`](#string) | The name of the gift registry owner. | +| `type` - [`String`](#string) | The type of event being held. | + +#### Example + +```json +{ + "event_date": "abc123", + "event_title": "xyz789", + "gift_registry_uid": "4", + "location": "abc123", + "name": "abc123", + "type": "xyz789" +} +``` + + + +### GiftRegistryShippingAddressInput + +Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID assigned to this customer address. | + +#### Example + +```json +{ + "address_data": CustomerAddressInput, + "address_id": 4, + "customer_address_uid": 4 +} +``` + + + +### GiftRegistryStatus + +Defines the status of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | + +#### Example + +```json +""ACTIVE"" +``` + + + +### GiftRegistryType + +Contains details about a gift registry type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | + +#### Example + +```json +{ + "dynamic_attributes_metadata": [ + GiftRegistryDynamicAttributeMetadataInterface + ], + "label": "xyz789", + "uid": 4 +} +``` + + + +### GiftWrapping + +Contains details about the selected or available gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `id` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. *(Deprecated: Use `uid` instead)* | +| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | +| `price` - [`Money!`](#money) | The gift wrapping price. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | + +#### Example + +```json +{ + "design": "abc123", + "id": 4, + "image": GiftWrappingImage, + "price": Money, + "uid": "4" +} +``` + + + +### GiftWrappingImage + +Points to an image associated with a gift wrapping option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The gift wrapping preview image label. | +| `url` - [`String!`](#string) | The gift wrapping preview image URL. | + +#### Example + +```json +{ + "label": "xyz789", + "url": "xyz789" +} +``` + + + +### GooglePayButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `type` - [`String`](#string) | The button type | + +#### Example + +```json +{ + "color": "xyz789", + "height": 987, + "type": "xyz789" +} +``` + + + +### GooglePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": GooglePayButtonStyles, + "code": "abc123", + "is_visible": false, + "payment_intent": "xyz789", + "payment_source": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "three_ds_mode": "OFF", + "title": "xyz789" +} +``` + + + +### GooglePayMethodInput + +Google Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "xyz789", + "paypal_order_id": "abc123" +} +``` + + + +### GroupedProduct + +Defines a grouped product, which consists of simple standalone products that are presented as a group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": false, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "id": 123, + "image": ProductImage, + "is_returnable": "xyz789", + "items": [GroupedProductItem], + "manufacturer": 123, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "xyz789", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "rating_summary": 123.45, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "abc123", + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 987.65, + "special_to_date": "xyz789", + "staged": false, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "tier_price": 123.45, + "tier_prices": [ProductTierPrices], + "type": "CMS_PAGE", + "type_id": "xyz789", + "uid": "4", + "updated_at": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### GroupedProductItem + +Contains information about an individual grouped product item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | +| `product` - [`ProductInterface`](#productinterface) | Details about this product option. | +| `qty` - [`Float`](#float) | The quantity of this grouped product item. | + +#### Example + +```json +{ + "position": 123, + "product": ProductInterface, + "qty": 987.65 +} +``` + + + +### GroupedProductWishlistItem + +A grouped product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### GuestOrderCancelInput + +Input to retrieve a guest order based on token. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `reason` - [`String!`](#string) | Cancellation reason. | +| `token` - [`String!`](#string) | Order token. | + +#### Example + +```json +{ + "reason": "xyz789", + "token": "xyz789" +} +``` + + + +### GuestOrderInformationInput + +Input to retrieve an order based on details. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | Order billing address email. | +| `lastname` - [`String!`](#string) | Order billing address lastname. | +| `number` - [`String!`](#string) | Order number. | + +#### Example + +```json +{ + "email": "abc123", + "lastname": "xyz789", + "number": "xyz789" +} +``` + + + +### HostedFieldsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cc_vault_code` - [`String`](#string) | Vault payment method code | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds` - [`Boolean`](#boolean) | Whether 3DS is activated; true if 3DS mode is not OFF. *(Deprecated: Use 'three_ds_mode' instead.)* | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "cc_vault_code": "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": "abc123", + "three_ds": true, + "three_ds_mode": "OFF", + "title": "xyz789" +} +``` + + + +### HostedFieldsInput + +Hosted Fields payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cardBin` - [`String`](#string) | Card bin number | +| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | +| `cardLast4` - [`String`](#string) | Last four digits of the card | +| `holderName` - [`String`](#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cardBin": "xyz789", + "cardExpiryMonth": "xyz789", + "cardExpiryYear": "xyz789", + "cardLast4": "abc123", + "holderName": "abc123", + "is_active_payment_token_enabler": true, + "payment_source": "xyz789", + "payments_order_id": "xyz789", + "paypal_order_id": "abc123" +} +``` + + + +### HostedProInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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!`](#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 + +```json +{ + "cancel_url": "xyz789", + "return_url": "abc123" +} +``` + + + +### HostedProUrl + +Contains the secure URL used for the Payments Pro Hosted Solution payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `secure_form_url` - [`String`](#string) | The secure URL generated by PayPal. | + +#### Example + +```json +{"secure_form_url": "xyz789"} +``` + + + +### HostedProUrlInput + +Contains the required input to request the secure URL for Payments Pro Hosted Solution payment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | + +#### Example + +```json +{"cart_id": "abc123"} +``` + + + +### HttpQueryParameter + +Contains target path parameters. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | A parameter name. | +| `value` - [`String`](#string) | A parameter value. | + +#### Example + +```json +{ + "name": "abc123", + "value": "abc123" +} +``` + + + +### ID + +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 + +```json +"4" +``` + + + +### ImageSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{ + "thumbnail": "abc123", + "value": "xyz789" +} +``` + + + +### InputFilterEnum + +List of templates/filters applied to customer attribute input. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""NONE"" +``` + + + +### InsufficientStockError + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | +| `quantity` - [`Float`](#float) | Amount of available stock | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123", + "quantity": 987.65 +} +``` + + + +### Int + +The `Int` scalar type represents non-fractional signed whole numeric +values. Int can represent values between -(2^31) and 2^31 - 1. + +#### Example + +```json +123 +``` + + + +### InternalError + +Contains an error message when an internal error occurred. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | + +#### Example + +```json +{"message": "abc123"} +``` + + + +### Invoice + +Contains invoice details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | +| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | +| `number` - [`String!`](#string) | Sequential invoice number. | +| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "id": "4", + "items": [InvoiceItemInterface], + "number": "abc123", + "total": InvoiceTotal +} +``` + + + +### InvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 123.45 +} +``` + + + +### InvoiceItemInterface + +Contains detailes about invoiced items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Possible Types + +| InvoiceItemInterface Types | +|----------------| +| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | +| [`InvoiceItem`](#invoiceitem) | + +#### Example + +```json +{ + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 123.45 +} +``` + + + +### InvoiceTotal + +Contains price details from an invoice. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | + +#### Example + +```json +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money +} +``` + + + +### IsCompanyAdminEmailAvailableOutput + +Contains the response of a company admin email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsCompanyEmailAvailableOutput + +Contains the response of a company email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsCompanyRoleNameAvailableOutput + +Contains the response of a role name validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | + +#### Example + +```json +{"is_role_name_available": true} +``` + + + +### IsCompanyUserEmailAvailableOutput + +Contains the response of a company user email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsEmailAvailableOutput + +Contains the result of the `isEmailAvailable` query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### ItemNote + +The note object for quote line item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | +| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | +| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | +| `note` - [`String`](#string) | Note text. | +| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | + +#### Example + +```json +{ + "created_at": "xyz789", + "creator_id": 123, + "creator_type": 987, + "negotiable_quote_item_uid": 4, + "note": "xyz789", + "note_uid": 4 +} +``` + + + +### ItemSelectedBundleOption + +A list of options of the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String!`](#string) | The label of the option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | +| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | + +#### Example + +```json +{ + "id": 4, + "label": "xyz789", + "uid": "4", + "values": [ItemSelectedBundleOptionValue] +} +``` + + + +### ItemSelectedBundleOptionValue + +A list of values for the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. *(Deprecated: Use `uid` instead.)* | +| `price` - [`Money!`](#money) | The price of the child bundle product. | +| `product_name` - [`String!`](#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | +| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | + +#### Example + +```json +{ + "id": "4", + "price": Money, + "product_name": "xyz789", + "product_sku": "abc123", + "quantity": 123.45, + "uid": "4" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-3.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md similarity index 58% rename from src/pages/includes/autogenerated/graphql-api-2-4-9-types-3.md rename to src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md index 083814950..c630b8e73 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-3.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-k-p.md @@ -1,5254 +1,2766 @@ -### NegotiableQuoteHistoryChanges +## Types -Contains a list of changes to a negotiable quote. +### KeyValue + +Contains a key-value pair. #### Fields | Field Name | Description | |------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | +| `name` - [`String`](#string) | The name part of the key/value pair. | +| `value` - [`String`](#string) | The value part of the key/value pair. | #### Example ```json { - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange + "name": "abc123", + "value": "abc123" } ``` -### NegotiableQuoteHistoryCommentChange +### LayerFilter -Contains a comment submitted by a seller or buyer. +Contains information for rendering layered navigation. #### Fields | Field Name | Description | |------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | +| `filter_items` - [`[LayerFilterItemInterface]`](#layerfilteriteminterface) | An array of filter items. *(Deprecated: Use `Aggregation.options` instead.)* | +| `filter_items_count` - [`Int`](#int) | The count of filter items in filter group. *(Deprecated: Use `Aggregation.count` instead.)* | +| `name` - [`String`](#string) | The name of a layered navigation filter. *(Deprecated: Use `Aggregation.label` instead.)* | +| `request_var` - [`String`](#string) | The request variable name for a filter query. *(Deprecated: Use `Aggregation.attribute_code` instead.)* | #### Example ```json -{"comment": "xyz789"} +{ + "filter_items": [LayerFilterItemInterface], + "filter_items_count": 987, + "name": "xyz789", + "request_var": "xyz789" +} ``` -### NegotiableQuoteHistoryEntry - -Contains details about a change for a negotiable quote. +### LayerFilterItem #### Fields | Field Name | Description | |------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | -| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | -| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | #### Example ```json { - "author": NegotiableQuoteUser, - "change_type": "CREATED", - "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", - "uid": "4" + "items_count": 987, + "label": "xyz789", + "value_string": "xyz789" } ``` -### NegotiableQuoteHistoryEntryChangeType +### LayerFilterItemInterface -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `CREATED` | | -| `UPDATED` | | -| `CLOSED` | | -| `UPDATED_BY_SYSTEM` | | +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Possible Types + +| LayerFilterItemInterface Types | +|----------------| +| [`LayerFilterItem`](#layerfilteritem) | +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | #### Example ```json -""CREATED"" +{ + "items_count": 123, + "label": "xyz789", + "value_string": "abc123" +} ``` -### NegotiableQuoteHistoryExpirationChange +### LineItemNoteInput -Contains a new expiration date and the previous date. +Sets quote item note. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | +| Input Field | Description | +|-------------|-------------| +| `note` - [`String`](#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "new_expiration": "abc123", - "old_expiration": "abc123" + "note": "xyz789", + "quote_item_uid": "4", + "quote_uid": "4" } ``` -### NegotiableQuoteHistoryProductsRemovedChange +### MediaGalleryEntry -Contains lists of products that have been removed from the catalog and negotiable quote. +Defines characteristics about images and videos associated with a specific product. #### Fields | Field Name | Description | |------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | -| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | +| `content` - [`ProductMediaGalleryEntriesContent`](#productmediagalleryentriescontent) | Details about the content of the media gallery item. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `file` - [`String`](#string) | The path of the image on the server. | +| `id` - [`Int`](#int) | The identifier assigned to the object. *(Deprecated: Use `uid` instead.)* | +| `label` - [`String`](#string) | The alt text displayed on the storefront when the user points to the image. | +| `media_type` - [`String`](#string) | Either `image` or `video`. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `uid` - [`ID!`](#id) | The unique ID for a `MediaGalleryEntry` object. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Details about the content of a video item. | #### Example ```json { - "products_removed_from_catalog": ["4"], - "products_removed_from_quote": [ProductInterface] + "content": ProductMediaGalleryEntriesContent, + "disabled": true, + "file": "xyz789", + "id": 987, + "label": "abc123", + "media_type": "xyz789", + "position": 987, + "types": ["xyz789"], + "uid": 4, + "video_content": ProductMediaGalleryEntriesVideoContent } ``` -### NegotiableQuoteHistoryStatusChange +### MediaGalleryInterface -Lists a new status change applied to a negotiable quote and the previous status. +Contains basic information about a product image or video. #### Fields | Field Name | Description | |------------|-------------| -| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | -| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Possible Types + +| MediaGalleryInterface Types | +|----------------| +| [`ProductImage`](#productimage) | +| [`ProductVideo`](#productvideo) | #### Example ```json -{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} +{ + "disabled": false, + "label": "abc123", + "position": 987, + "types": ["xyz789"], + "url": "xyz789" +} ``` -### NegotiableQuoteHistoryStatusesChange - -Contains a list of status changes that occurred for the negotiable quote. +### MessageStyleLogo #### Fields | Field Name | Description | |------------|-------------| -| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | +| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | #### Example ```json -{"changes": [NegotiableQuoteHistoryStatusChange]} +{"type": "abc123"} ``` -### NegotiableQuoteHistoryTotalChange - -Contains a new price and the previous price. +### MessageStyles #### Fields | Field Name | Description | |------------|-------------| -| `new_price` - [`Money`](#money) | The total price as a result of the change. | -| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | +| `layout` - [`String`](#string) | The message layout | +| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "new_price": Money, - "old_price": Money + "layout": "xyz789", + "logo": MessageStyleLogo } ``` -### NegotiableQuoteInvalidStateError +### Money -An error indicating that an operation was attempted on a negotiable quote in an invalid state. +Defines a monetary value, including a numeric value and a currency code. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | +| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](#float) | A number expressing a monetary value. | #### Example ```json -{"message": "abc123"} +{"currency": "AFN", "value": 123.45} ``` -### NegotiableQuoteItemQuantityInput +### MoveCartItemsToGiftRegistryOutput -Specifies the updated quantity of an item. +Contains the customer's gift registry and any errors encountered. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example ```json -{"quantity": 123.45, "quote_item_uid": "4"} +{ + "gift_registry": GiftRegistry, + "status": false, + "user_errors": [GiftRegistryItemsUserError] +} ``` -### NegotiableQuotePaymentMethodInput +### MoveItemsBetweenRequisitionListsInput -Defines the payment method to be applied to the negotiable quote. +An input object that defines the items in a requisition list to be moved. #### Input Fields | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -{ - "code": "xyz789", - "purchase_order_number": "xyz789" -} +{"requisitionListItemUids": ["4"]} ``` -### NegotiableQuoteReferenceDocumentLink +### MoveItemsBetweenRequisitionListsOutput -Contains a reference document link for a negotiable quote template. +Output of the request to move items to another requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `document_identifier` - [`String`](#string) | The identifier of the reference document. | -| `document_name` - [`String!`](#string) | The title of the reference document. | -| `link_id` - [`ID!`](#id) | The unique ID of a reference document link. | -| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | +| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | #### Example ```json { - "document_identifier": "xyz789", - "document_name": "abc123", - "link_id": "4", - "reference_document_url": "xyz789" + "destination_requisition_list": RequisitionList, + "source_requisition_list": RequisitionList } ``` -### NegotiableQuoteShippingAddress +### MoveLineItemToRequisitionListInput -#### Fields +Move Line Item to Requisition List. -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `telephone` - [`String`](#string) | The customer's telephone number. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | #### Example ```json { - "available_shipping_methods": [AvailableShippingMethod], - "city": "abc123", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "firstname": "abc123", - "lastname": "xyz789", - "postcode": "xyz789", - "region": NegotiableQuoteAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "telephone": "xyz789" + "quote_item_uid": "4", + "quote_uid": 4, + "requisition_list_uid": 4 } ``` -### NegotiableQuoteShippingAddressInput +### MoveLineItemToRequisitionListOutput -Defines shipping addresses for the negotiable quote. +Contains the updated negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | #### Example ```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "abc123" -} +{"quote": NegotiableQuote} ``` -### NegotiableQuoteSortInput +### MoveProductsBetweenWishlistsOutput -Defines the field to use to sort a list of negotiable quotes. +Contains the source and target wish lists after moving products. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | +| Field Name | Description | +|------------|-------------| +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example ```json -{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} +{ + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] +} ``` -### NegotiableQuoteSortableField +### NegotiableQuote -#### Values +Contains details about a negotiable quote. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `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. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | +| `email` - [`String`](#string) | The email address of the company user. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | +| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | #### Example ```json -""QUOTE_NAME"" +{ + "available_payment_methods": [AvailablePaymentMethod], + "billing_address": NegotiableQuoteBillingAddress, + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "created_at": "abc123", + "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" +} ``` -### NegotiableQuoteStatus +### NegotiableQuoteAddressCountry -#### Values +Defines the company's country. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `SUBMITTED` | | -| `PENDING` | | -| `UPDATED` | | -| `OPEN` | | -| `ORDERED` | | -| `CLOSED` | | -| `DECLINED` | | -| `EXPIRED` | | -| `DRAFT` | | +| `code` - [`String!`](#string) | The address country code. | +| `label` - [`String!`](#string) | The display name of the region. | #### Example ```json -""SUBMITTED"" +{ + "code": "xyz789", + "label": "abc123" +} ``` -### NegotiableQuoteTemplate +### NegotiableQuoteAddressInput -Contains details about a negotiable quote template. +Defines the billing or shipping address to be applied to the cart. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteReferenceDocumentLink]`](#negotiablequotereferencedocumentlink) | A list of reference document links for the negotiable quote template. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | +| Input Field | Description | +|-------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company name. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | #### Example ```json { - "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": 123, - "name": "xyz789", - "notifications": [QuoteTemplateNotificationMessage], - "prices": CartPrices, - "reference_document_links": [ - NegotiableQuoteReferenceDocumentLink - ], - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "abc123", - "template_id": "4", - "total_quantity": 987.65 + "city": "abc123", + "company": "abc123", + "country_code": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", + "postcode": "xyz789", + "region": "abc123", + "region_id": 123, + "save_in_address_book": true, + "street": ["abc123"], + "telephone": "xyz789" } ``` -### NegotiableQuoteTemplateFilterInput +### NegotiableQuoteAddressInterface -Defines a filter to limit the negotiable quotes to return. +#### Fields -#### Input Fields +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | -| Input Field | Description | -|-------------|-------------| -| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | +#### Possible Types + +| NegotiableQuoteAddressInterface Types | +|----------------| +| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | +| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | #### Example ```json { - "state": FilterEqualTypeInput, - "status": FilterEqualTypeInput + "city": "xyz789", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "xyz789", + "postcode": "xyz789", + "region": NegotiableQuoteAddressRegion, + "street": ["xyz789"], + "telephone": "abc123" } ``` -### NegotiableQuoteTemplateGridItem +### NegotiableQuoteAddressRegion -Contains data for a negotiable quote template in a grid. +Defines the company's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `state` - [`String!`](#string) | State of the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `code` - [`String`](#string) | The address region code. | +| `label` - [`String`](#string) | The display name of the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "activated_at": "abc123", - "company_name": "abc123", - "expiration_date": "abc123", - "is_min_max_qty_used": true, - "last_shared_at": "xyz789", - "max_order_commitment": 987, - "min_negotiated_grand_total": 987.65, - "min_order_commitment": 987, - "name": "abc123", - "orders_placed": 987, - "sales_rep_name": "abc123", - "state": "abc123", - "status": "xyz789", - "submitted_by": "abc123", - "template_id": 4 + "code": "xyz789", + "label": "xyz789", + "region_id": 987 } ``` -### NegotiableQuoteTemplateItemQuantityInput - -Specifies the updated quantity of an item. +### NegotiableQuoteBillingAddress -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | #### Example ```json { - "item_id": "4", - "max_qty": 987.65, - "min_qty": 123.45, - "quantity": 987.65 + "city": "xyz789", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "firstname": "abc123", + "lastname": "xyz789", + "postcode": "xyz789", + "region": NegotiableQuoteAddressRegion, + "street": ["xyz789"], + "telephone": "abc123" } ``` -### NegotiableQuoteTemplateReferenceDocumentLinkInput +### NegotiableQuoteBillingAddressInput -Defines the reference document link to add to a negotiable quote template. +Defines the billing address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `document_identifier` - [`String`](#string) | The identifier of the reference document. | -| `document_name` - [`String!`](#string) | The title of the reference document. | -| `link_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | -| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example ```json { - "document_identifier": "xyz789", - "document_name": "abc123", - "link_id": "4", - "reference_document_url": "abc123" + "address": NegotiableQuoteAddressInput, + "customer_address_uid": 4, + "same_as_shipping": false, + "use_for_shipping": true } ``` -### NegotiableQuoteTemplateShippingAddressInput +### NegotiableQuoteComment -Defines shipping addresses for the negotiable quote template. +Contains a single plain text comment from either the buyer or seller. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | +| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | +| `text` - [`String!`](#string) | The plain text comment. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "xyz789" + "author": NegotiableQuoteUser, + "created_at": "xyz789", + "creator_type": "BUYER", + "text": "xyz789", + "uid": "4" } ``` -### NegotiableQuoteTemplateSortInput - -Defines the field to use to sort a list of negotiable quotes. +### NegotiableQuoteCommentCreatorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | +| Enum Value | Description | +|------------|-------------| +| `BUYER` | | +| `SELLER` | | #### Example ```json -{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} +""BUYER"" ``` -### NegotiableQuoteTemplateSortableField +### NegotiableQuoteCommentInput -#### Values +Contains the commend provided by the buyer. -| Enum Value | Description | -|------------|-------------| -| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | -| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The comment provided by the buyer. | #### Example ```json -""TEMPLATE_ID"" +{"comment": "xyz789"} ``` -### NegotiableQuoteTemplatesOutput +### NegotiableQuoteCustomLogChange -Contains a list of negotiable templates that match the specified filter. +Contains custom log entries added by third-party extensions. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | +| `new_value` - [`String!`](#string) | The new entry content. | +| `old_value` - [`String`](#string) | The previous entry in the custom log. | +| `title` - [`String!`](#string) | The title of the custom log entry. | #### Example ```json { - "items": [NegotiableQuoteTemplateGridItem], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 123 + "new_value": "xyz789", + "old_value": "xyz789", + "title": "abc123" } ``` -### NegotiableQuoteUidNonFatalResultInterface - -#### Fields +### NegotiableQuoteFilterInput -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +Defines a filter to limit the negotiable quotes to return. -#### Possible Types +#### Input Fields -| NegotiableQuoteUidNonFatalResultInterface Types | -|----------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| Input Field | Description | +|-------------|-------------| +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example ```json -{"quote_uid": "4"} +{ + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput +} ``` -### NegotiableQuoteUidOperationSuccess +### NegotiableQuoteHistoryChanges -Contains details about a successful operation on a negotiable quote. +Contains a list of changes to a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | #### Example ```json -{"quote_uid": "4"} +{ + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange +} ``` -### NegotiableQuoteUser +### NegotiableQuoteHistoryCommentChange -A limited view of a Buyer or Seller in the negotiable quote process. +Contains a comment submitted by a seller or buyer. #### Fields | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | +| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{ - "firstname": "xyz789", - "lastname": "xyz789" -} +{"comment": "xyz789"} ``` -### NegotiableQuotesOutput +### NegotiableQuoteHistoryEntry -Contains a list of negotiable that match the specified filter. +Contains details about a change for a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | +| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | +| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example ```json { - "items": [NegotiableQuote], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 987 + "author": NegotiableQuoteUser, + "change_type": "CREATED", + "changes": NegotiableQuoteHistoryChanges, + "created_at": "abc123", + "uid": "4" } ``` -### NoSuchEntityUidError +### NegotiableQuoteHistoryEntryChangeType -Contains an error message when an invalid UID was specified. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | - -#### Example - -```json -{ - "message": "xyz789", - "uid": "4" -} -``` - - - -### OpenNegotiableQuoteTemplateInput - -Specifies the quote template id to open quote template. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": "4"} -``` - - - -### Order - -Contains the order ID. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | - -#### Example - -```json -{ - "order_id": "abc123", - "order_number": "xyz789" -} -``` - - - -### OrderActionType - -The list of available order actions. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REORDER` | | -| `CANCEL` | | -| `RETURN` | | - -#### Example - -```json -""REORDER"" -``` - - - -### OrderAddress - -Contains detailed information about an order's billing and shipping addresses. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `fax` - [`String`](#string) | The fax number. | -| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | The state or province name. | -| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "abc123", - "company": "abc123", - "country_code": "AF", - "custom_attributesV2": [AttributeValueInterface], - "fax": "abc123", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": "abc123", - "region_id": "4", - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" -} -``` - - - -### OrderCustomerInfo - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `firstname` - [`String!`](#string) | First name of the customer | -| `lastname` - [`String`](#string) | Last name of the customer | -| `middlename` - [`String`](#string) | Middle name of the customer | -| `prefix` - [`String`](#string) | Prefix of the customer | -| `suffix` - [`String`](#string) | Suffix of the customer | - -#### Example - -```json -{ - "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "abc123", - "prefix": "xyz789", - "suffix": "abc123" -} -``` - - - -### OrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "discounts": [Discount], - "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": "xyz789", - "product_url_key": "xyz789", - "quantity_canceled": 123.45, - "quantity_invoiced": 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" -} -``` - - - -### OrderItemInterface - -Order item details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Possible Types - -| OrderItemInterface Types | -|----------------| -| [`ConfigurableOrderItem`](#configurableorderitem) | -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`BundleOrderItem`](#bundleorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | -| [`OrderItem`](#orderitem) | - -#### Example - -```json -{ - "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": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### OrderItemOption - -Represents order item options like selected or entered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | - -#### Example - -```json -{ - "label": "abc123", - "value": "abc123" -} -``` - - - -### OrderItemPrices - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | -| `original_price` - [`Money`](#money) | The original price of the item. | -| `original_price_including_tax` - [`Money`](#money) | The original price of the item including tax. | -| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | -| `original_row_total_including_tax` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item including tax. | -| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money!`](#money) | The total of all discounts applied to the item. | - -#### Example - -```json -{ - "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 -} -``` - - - -### OrderPaymentMethod - -Contains details about the payment method used to pay for the order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](#string) | The label that describes the payment method. | -| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | - -#### Example - -```json -{ - "additional_data": [KeyValue], - "name": "abc123", - "type": "xyz789" -} -``` - - - -### OrderShipment - -Contains order shipment details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "id": 4, - "items": [ShipmentItemInterface], - "number": "abc123", - "tracking": [ShipmentTracking] -} -``` - - - -### OrderTokenInput - -Input to retrieve an order based on token. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{"token": "xyz789"} -``` - - - -### OrderTotal - -Contains details about the sales total amounts used to calculate the final price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `grand_total_excl_tax` - [`Money!`](#money) | The grand total of the order, excluding taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | -| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. *(Deprecated: Use subtotal_excl_tax field instead)* | -| `subtotal_excl_tax` - [`Money!`](#money) | The subtotal of the order, excluding taxes. | -| `subtotal_incl_tax` - [`Money!`](#money) | The subtotal of the order, including taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | -| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | -| `total_reward_points` - [`Money`](#money) | The total reward points applied to the order. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | -| `total_store_credit` - [`Money`](#money) | The total store credit applied to the order. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | - -#### Example - -```json -{ - "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 -} -``` - - - -### PayflowExpressInput - -Contains required input for Payflow Express Checkout payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | - -#### Example - -```json -{ - "payer_id": "xyz789", - "token": "xyz789" -} -``` - - - -### PayflowLinkInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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 - -```json -{ - "cancel_url": "abc123", - "error_url": "abc123", - "return_url": "abc123" -} -``` - - - -### PayflowLinkMode - -Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TEST` | | -| `LIVE` | | - -#### Example - -```json -""TEST"" -``` - - - -### PayflowLinkToken - -Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | -| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | -| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | -| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | - -#### Example - -```json -{ - "mode": "TEST", - "paypal_url": "abc123", - "secure_token": "xyz789", - "secure_token_id": "xyz789" -} -``` - - - -### PayflowLinkTokenInput - -Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PayflowProInput - -Contains input for the Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | -| `is_active_payment_token_enabler` - [`Boolean`](#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 - -```json -{ - "cc_details": CreditCardDetailsInput, - "is_active_payment_token_enabler": false -} -``` - - - -### PayflowProResponseInput - -Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "paypal_payload": "xyz789" -} -``` - - - -### PayflowProResponseOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### PayflowProTokenInput - -Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | - -#### Example - -```json -{ - "cart_id": "abc123", - "urls": PayflowProUrlInput -} -``` - - - -### PayflowProUrlInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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!`](#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!`](#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 - -```json -{ - "cancel_url": "abc123", - "error_url": "abc123", - "return_url": "xyz789" -} -``` - - - -### PaymentConfigItem - -Contains payment fields that are common to all types of payment methods. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Possible Types - -| PaymentConfigItem Types | -|----------------| -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | -| [`ApplePayConfig`](#applepayconfig) | -| [`GooglePayConfig`](#googlepayconfig) | -| [`FastlaneConfig`](#fastlaneconfig) | - -#### Example - -```json -{ - "code": "xyz789", - "is_visible": false, - "payment_intent": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" -} -``` - - - -### PaymentConfigOutput - -Retrieves the payment configuration for a given location - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | -| `fastlane` - [`FastlaneConfig`](#fastlaneconfig) | Fastlane payment method configuration | -| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | - -#### Example - -```json -{ - "apple_pay": ApplePayConfig, - "fastlane": FastlaneConfig, - "google_pay": GooglePayConfig, - "hosted_fields": HostedFieldsConfig, - "smart_buttons": SmartButtonsConfig -} -``` - - - -### PaymentLocation - -Defines the origin location for that payment request - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_DETAIL` | | -| `MINICART` | | -| `CART` | | -| `CHECKOUT` | | -| `START_OF_CHECKOUT` | | -| `ADMIN` | | - -#### Example - -```json -""PRODUCT_DETAIL"" -``` - - - -### PaymentMethodInput - -Defines the payment method. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `braintree` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_ach_direct_debit` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_applepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | -| `braintree_googlepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `braintree_paypal` - [`BraintreeInput`](#braintreeinput) | | -| `braintree_paypal_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | -| `code` - [`String!`](#string) | The internal name for the payment method. | -| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | -| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | -| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | -| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | -| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](#fastlanemethodinput) | Required input for fastlane | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | -| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | - -#### Example - -```json -{ - "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": "xyz789", - "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" -} -``` - - - -### PaymentOrderOutput - -Contains the payment order details - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](#string) | The status of the payment order | - -#### Example - -```json -{ - "id": "abc123", - "mp_order_id": "xyz789", - "payment_source_details": PaymentSourceDetails, - "status": "xyz789" -} -``` - - - -### PaymentSDKParamsItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | - -#### Example - -```json -{ - "code": "abc123", - "params": [SDKParams] -} -``` - - - -### PaymentSourceDetails - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | - -#### Example - -```json -{"card": Card} -``` - - - -### PaymentSourceInput - -The payment source information - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | - -#### Example - -```json -{"card": CardPaymentSourceInput} -``` - - - -### PaymentSourceOutput - -The payment source information - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | - -#### Example - -```json -{"card": CardPaymentSourceOutput} -``` - - - -### PaymentToken - -The stored payment method available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `details` - [`String`](#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](#string) | The public hash of the token. | -| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | - -#### Example - -```json -{ - "details": "abc123", - "payment_method_code": "abc123", - "public_hash": "abc123", - "type": "card" -} -``` - - - -### PaymentTokenTypeEnum - -The list of available payment token types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | -| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | - -#### Example - -```json -""card"" -``` - - - -### PaypalExpressInput - -Contains required input for Express Checkout and Payments Standard payments. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | -| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | - -#### Example - -```json -{ - "payer_id": "xyz789", - "token": "xyz789" -} -``` - - - -### PaypalExpressTokenInput - -Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `code` - [`String!`](#string) | The payment method code. | -| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | -| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | -| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | - -#### Example - -```json -{ - "cart_id": "abc123", - "code": "xyz789", - "express_button": false, - "urls": PaypalExpressUrlsInput, - "use_paypal_credit": true -} -``` - - - -### PaypalExpressTokenOutput - -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 Name | Description | -|------------|-------------| -| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | -| `token` - [`String`](#string) | The token returned by PayPal. | - -#### Example - -```json -{ - "paypal_urls": PaypalExpressUrlList, - "token": "abc123" -} -``` - - - -### PaypalExpressUrlList - -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 Name | Description | -|------------|-------------| -| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | -| `start` - [`String`](#string) | The URL to the PayPal login page. | - -#### Example - -```json -{ - "edit": "abc123", - "start": "xyz789" -} -``` - - - -### PaypalExpressUrlsInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 - -```json -{ - "cancel_url": "xyz789", - "pending_url": "xyz789", - "return_url": "xyz789", - "success_url": "abc123" -} -``` - - - -### PhysicalProductInterface - -Contains attributes specific to tangible products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Possible Types - -| PhysicalProductInterface Types | -|----------------| -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | - -#### Example - -```json -{"weight": 123.45} -``` - - - -### PickupLocation - -Defines Pickup Location information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | | -| `contact_name` - [`String`](#string) | | -| `country_id` - [`String`](#string) | | -| `description` - [`String`](#string) | | -| `email` - [`String`](#string) | | -| `fax` - [`String`](#string) | | -| `latitude` - [`Float`](#float) | | -| `longitude` - [`Float`](#float) | | -| `name` - [`String`](#string) | | -| `phone` - [`String`](#string) | | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | | -| `region` - [`String`](#string) | | -| `region_id` - [`Int`](#int) | | -| `street` - [`String`](#string) | | - -#### Example - -```json -{ - "city": "xyz789", - "contact_name": "abc123", - "country_id": "xyz789", - "description": "xyz789", - "email": "abc123", - "fax": "xyz789", - "latitude": 123.45, - "longitude": 987.65, - "name": "abc123", - "phone": "xyz789", - "pickup_location_code": "xyz789", - "postcode": "abc123", - "region": "abc123", - "region_id": 123, - "street": "abc123" -} -``` - - - -### PickupLocationFilterInput - -PickupLocationFilterInput defines the list of attributes and filters for the search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | - -#### Example - -```json -{ - "city": FilterTypeInput, - "country_id": FilterTypeInput, - "name": FilterTypeInput, - "pickup_location_code": FilterTypeInput, - "postcode": FilterTypeInput, - "region": FilterTypeInput, - "region_id": FilterTypeInput, - "street": FilterTypeInput -} -``` - - - -### PickupLocationSortInput - -PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | -| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | - -#### Example - -```json -{ - "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" -} -``` - - - -### PickupLocations - -Top level object returned in a pickup locations search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](#int) | The number of products returned. | - -#### Example - -```json -{ - "items": [PickupLocation], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### PlaceNegotiableQuoteOrderInput - -Specifies the negotiable quote to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_uid": "4"} -``` - - - -### PlaceNegotiableQuoteOrderOutput - -An output object that returns the generated order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`Order!`](#order) | Contains the generated order number. | - -#### Example - -```json -{"order": Order} -``` - - - -### PlaceOrderError - -An error encountered while placing an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Example - -```json -{ - "code": "CART_NOT_FOUND", - "message": "xyz789" -} -``` - - - -### PlaceOrderErrorCodes - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CART_NOT_FOUND` | | -| `CART_NOT_ACTIVE` | | -| `GUEST_EMAIL_MISSING` | | -| `UNABLE_TO_PLACE_ORDER` | | -| `UNDEFINED` | | - -#### Example - -```json -""CART_NOT_FOUND"" -``` - - - -### PlaceOrderForPurchaseOrderInput - -Specifies the purchase order to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | - -#### Example - -```json -{"purchase_order_uid": 4} -``` - - - -### PlaceOrderForPurchaseOrderOutput - -Contains the results of the request to place an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | - -#### Example - -```json -{"order": CustomerOrder} -``` - - - -### PlaceOrderInput - -Specifies the quote to be converted to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### PlaceOrderOutput - -Contains the results of the request to place an order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place order errors. | -| `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | -| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | - -#### Example - -```json -{ - "errors": [PlaceOrderError], - "order": Order, - "orderV2": CustomerOrder -} -``` - - - -### PlacePurchaseOrderInput - -Specifies the quote to be converted to a purchase order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### PlacePurchaseOrderOutput - -Contains the results of the request to place a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | - -#### Example - -```json -{"purchase_order": PurchaseOrder} -``` - - - -### Price - -Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | -| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | - -#### Example - -```json -{ - "adjustments": [PriceAdjustment], - "amount": Money -} -``` - - - -### PriceAdjustment - -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 Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | -| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | -| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | - -#### Example - -```json -{ - "amount": Money, - "code": "TAX", - "description": "INCLUDED" -} -``` - - - -### PriceAdjustmentCodesEnum - -`PriceAdjustment.code` is deprecated. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | -| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | -| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | - -#### Example - -```json -""TAX"" -``` - - - -### PriceAdjustmentDescriptionEnum - -`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INCLUDED` | | -| `EXCLUDED` | | - -#### Example - -```json -""INCLUDED"" -``` - - - -### PriceDetails - -Can be used to retrieve the main price details in case of bundle product - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](#float) | The regular price of the main product | - -#### Example - -```json -{ - "discount_percentage": 987.65, - "main_final_price": 123.45, - "main_price": 123.45 -} -``` - - - -### PriceRange - -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 Name | Description | -|------------|-------------| -| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | -| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | - -#### Example - -```json -{ - "maximum_price": ProductPrice, - "minimum_price": ProductPrice -} -``` - - - -### PriceTypeEnum - -Defines the price type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FIXED` | | -| `PERCENT` | | -| `DYNAMIC` | | - -#### Example - -```json -""FIXED"" -``` - - - -### PriceViewEnum - -Defines whether a bundle product's price is displayed as the lowest possible value or as a range. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRICE_RANGE` | | -| `AS_LOW_AS` | | - -#### Example - -```json -""PRICE_RANGE"" -``` - - - -### ProductAttribute - -Contains a product attribute code and value. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | - -#### Example - -```json -{ - "code": "abc123", - "value": "abc123" -} -``` - - - -### ProductAttributeFilterInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | -| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | -| `category_url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by category URL path. | -| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | -| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | -| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | -| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | -| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | - -#### Example - -```json -{ - "category_id": FilterEqualTypeInput, - "category_uid": FilterEqualTypeInput, - "category_url_path": FilterEqualTypeInput, - "description": FilterMatchTypeInput, - "name": FilterMatchTypeInput, - "price": FilterRangeTypeInput, - "short_description": FilterMatchTypeInput, - "sku": FilterEqualTypeInput, - "url_key": FilterEqualTypeInput -} -``` - - - -### ProductAttributeSortInput - -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 - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | -| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | -| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | -| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | - -#### Example - -```json -{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} -``` - - - -### ProductCustomAttributes - -Product custom attributes - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | - -#### Example - -```json -{ - "errors": [AttributeMetadataError], - "items": [AttributeValueInterface] -} -``` - - - -### ProductDiscount - -Contains the discount applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | - -#### Example - -```json -{"amount_off": 987.65, "percent_off": 987.65} -``` - - - -### ProductFilterInput - -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. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | -| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | -| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | -| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | -| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | -| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | -| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | -| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | -| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | -| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | -| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | -| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | -| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | -| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | -| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | -| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | -| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | -| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | -| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | -| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | -| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | -| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | -| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | -| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | -| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | -| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | -| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | -| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | -| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | -| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | -| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | -| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "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 -} -``` - - - -### ProductImage - -Contains product image information, including the image URL and label. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Example - -```json -{ - "disabled": false, - "label": "xyz789", - "position": 987, - "types": ["abc123"], - "url": "abc123" -} -``` - - - -### ProductImageThumbnail - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ITSELF` | Use thumbnail of product as image. | -| `PARENT` | Use thumbnail of product's parent as image. | - -#### Example - -```json -""ITSELF"" -``` - - - -### ProductInfoInput - -Product Information used for Pickup Locations search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | - -#### Example - -```json -{"sku": "xyz789"} -``` - - - -### ProductInterface - -Contains fields that are common to all types of products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Amount of available stock | -| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | -| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | -| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | -| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | -| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | -| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | -| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | - -#### Possible Types - -| ProductInterface Types | -|----------------| -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | - -#### Example - -```json -{ - "attribute_set_id": 987, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "color": 123, - "country_of_manufacture": "xyz789", - "created_at": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "id": 123, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "media_gallery_entries": [MediaGalleryEntry], - "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options_container": "abc123", - "price": ProductPrices, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "rating_summary": 987.65, - "related_products": [ProductInterface], - "review_count": 987, - "reviews": ProductReviews, - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_from_date": "abc123", - "special_price": 987.65, - "special_to_date": "xyz789", - "staged": true, - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "tier_price": 987.65, - "tier_prices": [ProductTierPrices], - "type_id": "abc123", - "uid": 4, - "updated_at": "abc123", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "url_path": "xyz789", - "url_rewrites": [UrlRewrite], - "url_suffix": "xyz789", - "websites": [Website] -} -``` - - - -### ProductLinks - -An implementation of `ProductLinksInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Example - -```json -{ - "link_type": "xyz789", - "linked_product_sku": "abc123", - "linked_product_type": "xyz789", - "position": 987, - "sku": "xyz789" -} -``` - - - -### ProductLinksInterface - -Contains information about linked products, including the link type and product type of each item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Possible Types - -| ProductLinksInterface Types | -|----------------| -| [`ProductLinks`](#productlinks) | - -#### Example - -```json -{ - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 987, - "sku": "xyz789" -} -``` - - - -### ProductMediaGalleryEntriesContent - -Contains an image in base64 format and basic information about the image. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | -| `name` - [`String`](#string) | The file name of the image. | -| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | - -#### Example - -```json -{ - "base64_encoded_data": "xyz789", - "name": "xyz789", - "type": "abc123" -} -``` - - - -### ProductMediaGalleryEntriesVideoContent - -Contains a link to a video file and basic information about the video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `media_type` - [`String`](#string) | Must be external-video. | -| `video_description` - [`String`](#string) | A description of the video. | -| `video_metadata` - [`String`](#string) | Optional data about the video. | -| `video_provider` - [`String`](#string) | Describes the video source. | -| `video_title` - [`String`](#string) | The title of the video. | -| `video_url` - [`String`](#string) | The URL to the video. | - -#### Example - -```json -{ - "media_type": "abc123", - "video_description": "xyz789", - "video_metadata": "abc123", - "video_provider": "abc123", - "video_title": "xyz789", - "video_url": "abc123" -} -``` - - - -### ProductPrice - -Represents a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | -| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | -| `regular_price` - [`Money!`](#money) | The regular price of the product. | - -#### Example - -```json -{ - "discount": ProductDiscount, - "final_price": Money, - "fixed_product_taxes": [FixedProductTax], - "regular_price": Money -} -``` - - - -### ProductPrices - -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 Name | Description | -|------------|-------------| -| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | -| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | -| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | - -#### Example - -```json -{ - "maximalPrice": Price, - "minimalPrice": Price, - "regularPrice": Price -} -``` - - - -### ProductReview - -Contains details of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | -| `created_at` - [`String!`](#string) | The date the review was created. | -| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | -| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | -| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | -| `summary` - [`String!`](#string) | The summary (title) of the review. | -| `text` - [`String!`](#string) | The review text. | - -#### Example - -```json -{ - "average_rating": 987.65, - "created_at": "xyz789", - "nickname": "abc123", - "product": ProductInterface, - "ratings_breakdown": [ProductReviewRating], - "summary": "xyz789", - "text": "abc123" -} -``` - - - -### ProductReviewRating - -Contains data about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### ProductReviewRatingInput - -Contains the reviewer's rating for a single aspect of a review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "id": "xyz789", - "value_id": "abc123" -} -``` - - - -### ProductReviewRatingMetadata - -Contains details about a single aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `id` - [`String!`](#string) | An encoded rating ID. | -| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | -| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | - -#### Example - -```json -{ - "id": "abc123", - "name": "abc123", - "values": [ProductReviewRatingValueMetadata] -} -``` - - - -### ProductReviewRatingValueMetadata - -Contains details about a single value in a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | -| `value_id` - [`String!`](#string) | An encoded rating value ID. | - -#### Example - -```json -{ - "value": "xyz789", - "value_id": "abc123" -} -``` - - - -### ProductReviewRatingsMetadata - -Contains an array of metadata about each aspect of a product review. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | - -#### Example - -```json -{"items": [ProductReviewRatingMetadata]} -``` - - - -### ProductReviews - -Contains an array of product reviews. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | - -#### Example - -```json -{ - "items": [ProductReview], - "page_info": SearchResultPageInfo -} -``` - - - -### ProductStockStatus - -This enumeration states whether a product stock status is in stock or out of stock - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `IN_STOCK` | | -| `OUT_OF_STOCK` | | - -#### Example - -```json -""IN_STOCK"" -``` - - - -### ProductTierPrices - -Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | -| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | -| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | -| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | -| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | - -#### Example - -```json -{ - "customer_group_id": "abc123", - "percentage_value": 123.45, - "qty": 123.45, - "value": 987.65, - "website_id": 987.65 -} -``` - - - -### ProductVideo - -Contains information about a product video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | -| `url` - [`String`](#string) | The URL of the product image or video. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | - -#### Example - -```json -{ - "disabled": false, - "label": "xyz789", - "position": 123, - "types": ["xyz789"], - "url": "xyz789", - "video_content": ProductMediaGalleryEntriesVideoContent -} -``` - - - -### Products - -Contains the results of a `products` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | -| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | -| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | -| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | -| `total_count` - [`Int`](#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 - -```json -{ - "aggregations": [Aggregation], - "filters": [LayerFilter], - "items": [ProductInterface], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "suggestions": [SearchSuggestion], - "total_count": 987 -} -``` - - - -### PurchaseOrder - -Contains details about a purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | -| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | -| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | -| `created_at` - [`String!`](#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | -| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | -| `number` - [`String!`](#string) | The purchase order number. | -| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | -| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | - -#### Example - -```json -{ - "approval_flow": [PurchaseOrderRuleApprovalFlow], - "available_actions": ["REJECT"], - "comments": [PurchaseOrderComment], - "created_at": "abc123", - "created_by": Customer, - "history_log": [PurchaseOrderHistoryItem], - "number": "abc123", - "order": CustomerOrder, - "quote": Cart, - "status": "PENDING", - "uid": 4, - "updated_at": "abc123" -} -``` - - - -### PurchaseOrderAction - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REJECT` | | -| `CANCEL` | | -| `VALIDATE` | | -| `APPROVE` | | -| `PLACE_ORDER` | | - -#### Example - -```json -""REJECT"" -``` - - - -### PurchaseOrderActionError - -Contains details about a failed action. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | - -#### Example - -```json -{"message": "abc123", "type": "NOT_FOUND"} -``` - - - -### PurchaseOrderApprovalFlowEvent - -Contains details about a single event in the approval flow of the purchase order. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | -| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](#string) | The date and time the event was updated. | - -#### Example - -```json -{ - "message": "xyz789", - "name": "abc123", - "role": "abc123", - "status": "PENDING", - "updated_at": "xyz789" -} -``` - - - -### PurchaseOrderApprovalFlowItemStatus - -#### Values +#### Values | Enum Value | Description | |------------|-------------| -| `PENDING` | | -| `APPROVED` | | -| `REJECTED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrderApprovalRule - -Contains details about a purchase order approval rule. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | -| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | -| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](#string) | The name of the purchase order approval rule. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | +| `CREATED` | | +| `UPDATED` | | +| `CLOSED` | | +| `UPDATED_BY_SYSTEM` | | #### Example ```json -{ - "applies_to_roles": [CompanyRole], - "approver_roles": [CompanyRole], - "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", - "created_by": "xyz789", - "description": "xyz789", - "name": "xyz789", - "status": "ENABLED", - "uid": "4", - "updated_at": "xyz789" -} +""CREATED"" ``` -### PurchaseOrderApprovalRuleConditionAmount +### NegotiableQuoteHistoryExpirationChange -Contains approval rule condition details, including the amount to be evaluated. +Contains a new expiration date and the previous date. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "amount": Money, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN" + "new_expiration": "xyz789", + "old_expiration": "xyz789" } ``` -### PurchaseOrderApprovalRuleConditionInterface - -Purchase order rule condition details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Possible Types - -| PurchaseOrderApprovalRuleConditionInterface Types | -|----------------| -| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | -| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} -``` - - - -### PurchaseOrderApprovalRuleConditionOperator - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `MORE_THAN` | | -| `LESS_THAN` | | -| `MORE_THAN_OR_EQUAL_TO` | | -| `LESS_THAN_OR_EQUAL_TO` | | - -#### Example - -```json -""MORE_THAN"" -``` - - - -### PurchaseOrderApprovalRuleConditionQuantity +### NegotiableQuoteHistoryProductsRemovedChange -Contains approval rule condition details, including the quantity to be evaluated. +Contains lists of products that have been removed from the catalog and negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | -| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | - -#### Example - -```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} -``` - - - -### PurchaseOrderApprovalRuleInput - -Defines a new purchase order approval rule. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](#string) | The purchase order approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. | #### Example ```json { - "applies_to": ["4"], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "xyz789", - "status": "ENABLED" + "products_removed_from_catalog": [4], + "products_removed_from_quote": [ProductInterface] } ``` -### PurchaseOrderApprovalRuleMetadata - -Contains metadata that can be used to render rule edit forms. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | - -#### Example - -```json -{ - "available_applies_to": [CompanyRole], - "available_condition_currencies": [AvailableCurrency], - "available_requires_approval_from": [CompanyRole] -} -``` - - +### NegotiableQuoteHistoryStatusChange -### PurchaseOrderApprovalRuleStatus +Lists a new status change applied to a negotiable quote and the previous status. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ENABLED` | | -| `DISABLED` | | +| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | +| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json -""ENABLED"" +{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} ``` -### PurchaseOrderApprovalRuleType +### NegotiableQuoteHistoryStatusesChange -#### Values +Contains a list of status changes that occurred for the negotiable quote. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `GRAND_TOTAL` | | -| `SHIPPING_INCL_TAX` | | -| `NUMBER_OF_SKUS` | | +| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | #### Example ```json -""GRAND_TOTAL"" +{"changes": [NegotiableQuoteHistoryStatusChange]} ``` -### PurchaseOrderApprovalRules +### NegotiableQuoteHistoryTotalChange -Contains the approval rules that the customer can see. +Contains a new price and the previous price. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | +| `new_price` - [`Money`](#money) | The total price as a result of the change. | +| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | #### Example ```json { - "items": [PurchaseOrderApprovalRule], - "page_info": SearchResultPageInfo, - "total_count": 123 + "new_price": Money, + "old_price": Money } ``` -### PurchaseOrderComment +### NegotiableQuoteInvalidStateError -Contains details about a comment. +An error indicating that an operation was attempted on a negotiable quote in an invalid state. #### Fields | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](#customer) | The user who left the comment. | -| `created_at` - [`String!`](#string) | The date and time when the comment was created. | -| `text` - [`String!`](#string) | The text of the comment. | -| `uid` - [`ID!`](#id) | A unique identifier of the comment. | +| `message` - [`String!`](#string) | The returned error message. | #### Example ```json -{ - "author": Customer, - "created_at": "xyz789", - "text": "abc123", - "uid": 4 -} +{"message": "abc123"} ``` -### PurchaseOrderErrorType +### NegotiableQuoteItemQuantityInput -#### Values +Specifies the updated quantity of an item. -| Enum Value | Description | -|------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -""NOT_FOUND"" +{"quantity": 123.45, "quote_item_uid": 4} ``` -### PurchaseOrderHistoryItem +### NegotiableQuotePaymentMethodInput -Contains details about a status change. +Defines the payment method to be applied to the negotiable quote. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `activity` - [`String!`](#string) | The activity type of the event. | -| `created_at` - [`String!`](#string) | The date and time when the event happened. | -| `message` - [`String!`](#string) | The message representation of the event. | -| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | +| Input Field | Description | +|-------------|-------------| +| `code` - [`String!`](#string) | Payment method code | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "activity": "abc123", - "created_at": "abc123", - "message": "xyz789", - "uid": "4" + "code": "xyz789", + "purchase_order_number": "xyz789" } ``` -### PurchaseOrderRuleApprovalFlow +### NegotiableQuoteReferenceDocumentLink -Contains details about approval roles applied to the purchase order and status changes. +Contains a reference document link for a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | +| `document_identifier` - [`String`](#string) | The identifier of the reference document. | +| `document_name` - [`String!`](#string) | The title of the reference document. | +| `link_id` - [`ID!`](#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | #### Example ```json { - "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "abc123" + "document_identifier": "xyz789", + "document_name": "abc123", + "link_id": "4", + "reference_document_url": "xyz789" } ``` -### PurchaseOrderStatus +### NegotiableQuoteShippingAddress -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `PENDING` | | -| `APPROVAL_REQUIRED` | | -| `APPROVED` | | -| `ORDER_IN_PROGRESS` | | -| `ORDER_PLACED` | | -| `ORDER_FAILED` | | -| `REJECTED` | | -| `CANCELED` | | -| `APPROVED_PENDING_PAYMENT` | | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `telephone` - [`String`](#string) | The customer's telephone number. | #### Example ```json -""PENDING"" +{ + "available_shipping_methods": [AvailableShippingMethod], + "city": "xyz789", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "firstname": "xyz789", + "lastname": "xyz789", + "postcode": "abc123", + "region": NegotiableQuoteAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "telephone": "xyz789" +} ``` -### PurchaseOrders +### NegotiableQuoteShippingAddressInput -Contains a list of purchase orders. +Defines shipping addresses for the negotiable quote. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json { - "items": [PurchaseOrder], - "page_info": SearchResultPageInfo, - "total_count": 123 + "address": NegotiableQuoteAddressInput, + "customer_address_uid": 4, + "customer_notes": "abc123" } ``` -### PurchaseOrdersActionInput +### NegotiableQuoteSortInput -Defines which purchase orders to act on. +Defines the field to use to sort a list of negotiable quotes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example ```json -{"purchase_order_uids": [4]} +{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} ``` -### PurchaseOrdersActionOutput - -Returns a list of updated purchase orders and any error messages. +### NegotiableQuoteSortableField -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | +| `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 ```json -{ - "errors": [PurchaseOrderActionError], - "purchase_orders": [PurchaseOrder] -} +""QUOTE_NAME"" ``` -### PurchaseOrdersFilterInput - -Defines the criteria to use to filter the list of purchase orders. +### NegotiableQuoteStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | -| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | +| Enum Value | Description | +|------------|-------------| +| `SUBMITTED` | | +| `PENDING` | | +| `UPDATED` | | +| `OPEN` | | +| `ORDERED` | | +| `CLOSED` | | +| `DECLINED` | | +| `EXPIRED` | | +| `DRAFT` | | #### Example ```json -{ - "company_purchase_orders": false, - "created_date": FilterRangeTypeInput, - "require_my_approval": false, - "status": "PENDING" -} +""SUBMITTED"" ``` -### QuoteItemsSortInput +### NegotiableQuoteTemplate -Specifies the field to use for sorting quote items +Contains details about a negotiable quote template. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | -| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | +| Field Name | Description | +|------------|-------------| +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `reference_document_links` - [`[NegotiableQuoteReferenceDocumentLink]`](#negotiablequotereferencedocumentlink) | A list of reference document links for the negotiable quote template. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | #### Example ```json -{"field": "ITEM_ID", "order": "ASC"} +{ + "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": "abc123", + "template_id": "4", + "total_quantity": 123.45 +} ``` -### QuoteTemplateLineItemNoteInput +### NegotiableQuoteTemplateFilterInput -Sets quote item note. +Defines a filter to limit the negotiable quotes to return. #### Input Fields | Input Field | Description | |-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example ```json { - "item_id": "4", - "note": "xyz789", - "templateId": 4 + "state": FilterEqualTypeInput, + "status": FilterEqualTypeInput } ``` -### QuoteTemplateNotificationMessage +### NegotiableQuoteTemplateGridItem -Contains a notification message for a negotiable quote template. +Contains data for a negotiable quote template in a grid. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The notification message. | -| `type` - [`String!`](#string) | The type of notification message. | +| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `state` - [`String!`](#string) | State of the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json { - "message": "abc123", - "type": "abc123" + "activated_at": "abc123", + "company_name": "xyz789", + "expiration_date": "xyz789", + "is_min_max_qty_used": false, + "last_shared_at": "abc123", + "max_order_commitment": 123, + "min_negotiated_grand_total": 987.65, + "min_order_commitment": 987, + "name": "abc123", + "orders_placed": 987, + "sales_rep_name": "abc123", + "state": "xyz789", + "status": "xyz789", + "submitted_by": "xyz789", + "template_id": 4 } ``` -### ReCaptchaConfigOutput +### NegotiableQuoteTemplateItemQuantityInput -#### Fields +Specifies the updated quantity of an item. -| Field Name | Description | -|------------|-------------| -| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | #### Example ```json { - "configurations": ReCaptchaConfiguration, - "is_enabled": false + "item_id": "4", + "max_qty": 123.45, + "min_qty": 987.65, + "quantity": 123.45 } ``` -### ReCaptchaConfiguration +### NegotiableQuoteTemplateReferenceDocumentLinkInput -Contains reCAPTCHA form configuration details. +Defines the reference document link to add to a negotiable quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `badge_position` - [`String`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `re_captcha_type` - [`ReCaptchaTypeEmum!`](#recaptchatypeemum) | | -| `technical_failure_message` - [`String!`](#string) | The message that appears when reCaptcha fails. | -| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | -| `validation_failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | +| Input Field | Description | +|-------------|-------------| +| `document_identifier` - [`String`](#string) | The identifier of the reference document. | +| `document_name` - [`String!`](#string) | The title of the reference document. | +| `link_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | #### Example ```json { - "badge_position": "xyz789", - "language_code": "abc123", - "minimum_score": 123.45, - "re_captcha_type": "INVISIBLE", - "technical_failure_message": "abc123", - "theme": "xyz789", - "validation_failure_message": "abc123", - "website_key": "xyz789" + "document_identifier": "abc123", + "document_name": "abc123", + "link_id": 4, + "reference_document_url": "xyz789" } ``` -### ReCaptchaConfigurationV3 +### NegotiableQuoteTemplateShippingAddressInput -Contains reCAPTCHA V3-Invisible configuration details. +Defines shipping addresses for the negotiable quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | -| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json { - "badge_position": "xyz789", - "failure_message": "abc123", - "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 987.65, - "theme": "xyz789", - "website_key": "abc123" + "address": NegotiableQuoteAddressInput, + "customer_address_uid": 4, + "customer_notes": "xyz789" } ``` -### ReCaptchaFormEnum +### NegotiableQuoteTemplateSortInput + +Defines the field to use to sort a list of negotiable quotes. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `PLACE_ORDER` | | -| `CONTACT` | | -| `CUSTOMER_LOGIN` | | -| `CUSTOMER_FORGOT_PASSWORD` | | -| `CUSTOMER_CREATE` | | -| `CUSTOMER_EDIT` | | -| `NEWSLETTER` | | -| `PRODUCT_REVIEW` | | -| `SENDFRIEND` | | -| `BRAINTREE` | | -| `RESEND_CONFIRMATION_EMAIL` | | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example ```json -""PLACE_ORDER"" +{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} ``` -### ReCaptchaTypeEmum +### NegotiableQuoteTemplateSortableField #### Values | Enum Value | Description | |------------|-------------| -| `INVISIBLE` | | -| `RECAPTCHA` | | -| `RECAPTCHA_V3` | | +| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | +| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | #### Example ```json -""INVISIBLE"" +""TEMPLATE_ID"" ``` -### Region +### NegotiableQuoteTemplatesOutput + +Contains a list of negotiable templates that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](#int) | The unique ID for a `Region` object. | -| `name` - [`String`](#string) | The name of the region, such as Texas. | +| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | #### Example ```json { - "code": "abc123", - "id": 123, - "name": "abc123" + "items": [NegotiableQuoteTemplateGridItem], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 987 } ``` -### RemoveCouponFromCartInput - -Specifies the cart from which to remove a coupon. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### RemoveCouponFromCartOutput - -Contains details about the cart after removing a coupon. +### NegotiableQuoteUidNonFatalResultInterface #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveCouponsFromCartInput - -Remove coupons from the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#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 - -```json -{ - "cart_id": "xyz789", - "coupon_codes": ["xyz789"] -} -``` - - - -### RemoveGiftCardFromCartInput - -Defines the input required to run the `removeGiftCardFromCart` mutation. +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | +| NegotiableQuoteUidNonFatalResultInterface Types | +|----------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | #### Example ```json -{ - "cart_id": "xyz789", - "gift_card_code": "xyz789" -} +{"quote_uid": "4"} ``` -### RemoveGiftCardFromCartOutput +### NegotiableQuoteUidOperationSuccess -Defines the possible output for the `removeGiftCardFromCart` mutation. +Contains details about a successful operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"cart": Cart} +{"quote_uid": 4} ``` -### RemoveGiftRegistryItemsOutput +### NegotiableQuoteUser -Contains the results of a request to remove an item from a gift registry. +A limited view of a Buyer or Seller in the negotiable quote process. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | +| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "firstname": "xyz789", + "lastname": "xyz789" +} ``` -### RemoveGiftRegistryOutput +### NegotiableQuotesOutput -Contains the results of a request to delete a gift registry. +Contains a list of negotiable that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | +| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | #### Example ```json -{"success": true} +{ + "items": [NegotiableQuote], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 +} ``` -### RemoveGiftRegistryRegistrantsOutput +### NoSuchEntityUidError -Contains the results of a request to delete a registrant. +Contains an error message when an invalid UID was specified. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | +| `message` - [`String!`](#string) | The returned error message. | +| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "message": "xyz789", + "uid": "4" +} ``` -### RemoveItemFromCartInput +### OpenNegotiableQuoteTemplateInput -Specifies which items to remove from the cart. +Specifies the quote template id to open quote template. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | -| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{ - "cart_id": "xyz789", - "cart_item_id": 123, - "cart_item_uid": 4 -} +{"template_id": "4"} ``` -### RemoveItemFromCartOutput +### Order -Contains details about the cart after removing an item. +Contains the order ID. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | +| `order_id` - [`String`](#string) | *(Deprecated: Use `order_number` instead.)* | +| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | #### Example ```json -{"cart": Cart} +{ + "order_id": "abc123", + "order_number": "xyz789" +} ``` -### RemoveNegotiableQuoteItemsInput +### OrderActionType -Defines the items to remove from the specified negotiable quote. +The list of available order actions. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Enum Value | Description | +|------------|-------------| +| `REORDER` | | +| `CANCEL` | | +| `RETURN` | | #### Example ```json -{"quote_item_uids": ["4"], "quote_uid": 4} +""REORDER"" ``` -### RemoveNegotiableQuoteItemsOutput +### OrderAddress -Contains the negotiable quote. +Contains detailed information about an order's billing and shipping addresses. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### RemoveNegotiableQuoteTemplateItemsInput - -Defines the items to remove from the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `city` - [`String!`](#string) | The city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](#string) | The fax number. | +| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | The state or province name. | +| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json -{"item_uids": [4], "template_id": "4"} +{ + "city": "abc123", + "company": "abc123", + "country_code": "AF", + "custom_attributesV2": [AttributeValueInterface], + "fax": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "abc123", + "region": "abc123", + "region_id": "4", + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" +} ``` -### RemoveProductsFromCompareListInput - -Defines which products to remove from a compare list. +### OrderCustomerInfo -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| Field Name | Description | +|------------|-------------| +| `firstname` - [`String!`](#string) | First name of the customer | +| `lastname` - [`String`](#string) | Last name of the customer | +| `middlename` - [`String`](#string) | Middle name of the customer | +| `prefix` - [`String`](#string) | Prefix of the customer | +| `suffix` - [`String`](#string) | Suffix of the customer | #### Example ```json -{"products": [4], "uid": 4} +{ + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "xyz789", + "prefix": "xyz789", + "suffix": "abc123" +} ``` -### RemoveProductsFromWishlistOutput - -Contains the customer's wish list and any errors encountered. +### OrderItem #### Fields | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "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": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", + "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": "abc123" } ``` -### RemoveReturnTrackingInput +### OrderItemInterface -Defines the tracking information to delete. +Order item details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | +| Field Name | Description | +|------------|-------------| +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Possible Types + +| OrderItemInterface Types | +|----------------| +| [`ConfigurableOrderItem`](#configurableorderitem) | +| [`DownloadableOrderItem`](#downloadableorderitem) | +| [`BundleOrderItem`](#bundleorderitem) | +| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`OrderItem`](#orderitem) | #### Example ```json -{"return_shipping_tracking_uid": "4"} +{ + "discounts": [Discount], + "eligible_for_return": false, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": 4, + "prices": OrderItemPrices, + "product": ProductInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "abc123", + "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": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} ``` -### RemoveReturnTrackingOutput +### OrderItemOption -Contains the response after deleting tracking information. +Represents order item options like selected or entered. #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Contains details about the modified return. | +| `label` - [`String!`](#string) | The name of the option. | +| `value` - [`String!`](#string) | The value of the option. | #### Example ```json -{"return": Return} +{ + "label": "abc123", + "value": "abc123" +} ``` -### RemoveRewardPointsFromCartOutput - -Contains the customer cart. +### OrderItemPrices #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | +| `original_price` - [`Money`](#money) | The original price of the item. | +| `original_price_including_tax` - [`Money`](#money) | The original price of the item including tax. | +| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | +| `original_row_total_including_tax` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item including tax. | +| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money!`](#money) | The total of all discounts applied to the item. | #### Example ```json -{"cart": Cart} +{ + "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 +} ``` -### RemoveStoreCreditFromCartInput +### OrderPaymentMethod -Defines the input required to run the `removeStoreCreditFromCart` mutation. +Contains details about the payment method used to pay for the order. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| Field Name | Description | +|------------|-------------| +| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | +| `name` - [`String!`](#string) | The label that describes the payment method. | +| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | #### Example ```json -{"cart_id": "abc123"} +{ + "additional_data": [KeyValue], + "name": "abc123", + "type": "xyz789" +} ``` -### RemoveStoreCreditFromCartOutput +### OrderShipment -Defines the possible output for the `removeStoreCreditFromCart` mutation. +Contains order shipment details. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | #### Example ```json -{"cart": Cart} +{ + "comments": [SalesCommentItem], + "id": "4", + "items": [ShipmentItemInterface], + "number": "abc123", + "tracking": [ShipmentTracking] +} ``` -### RenameNegotiableQuoteInput +### OrderTokenInput -Sets new name for a negotiable quote. +Input to retrieve an order based on token. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | -| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | -| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `token` - [`String!`](#string) | Order token. | #### Example ```json -{ - "quote_comment": "xyz789", - "quote_name": "abc123", - "quote_uid": "4" -} +{"token": "xyz789"} ``` -### RenameNegotiableQuoteOutput +### OrderTotal -Contains the updated negotiable quote. +Contains details about the sales total amounts used to calculate the final price. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `grand_total_excl_tax` - [`Money!`](#money) | The grand total of the order, excluding taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | +| `subtotal` - [`Money!`](#money) | The subtotal of the order, excluding shipping, discounts, and taxes. *(Deprecated: Use subtotal_excl_tax field instead)* | +| `subtotal_excl_tax` - [`Money!`](#money) | The subtotal of the order, excluding taxes. | +| `subtotal_incl_tax` - [`Money!`](#money) | The subtotal of the order, including taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | +| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | +| `total_reward_points` - [`Money`](#money) | The total reward points applied to the order. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | +| `total_store_credit` - [`Money`](#money) | The total store credit applied to the order. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | #### Example ```json -{"quote": NegotiableQuote} +{ + "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 +} ``` -### ReorderItemsOutput +### PayflowExpressInput -Contains the cart and any errors after adding products. +Contains required input for Payflow Express Checkout payments. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | +| Input Field | Description | +|-------------|-------------| +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the createPaypalExpressToken mutation. | #### Example ```json { - "cart": Cart, - "userInputErrors": [CheckoutUserInputError] + "payer_id": "xyz789", + "token": "xyz789" } ``` -### RequestGuestReturnInput +### PayflowLinkInput -Contains information needed to start a return request. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `token` - [`String!`](#string) | Order token. | +| `cancel_url` - [`String!`](#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!`](#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!`](#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 ```json { - "comment_text": "xyz789", - "contact_email": "xyz789", - "items": [RequestReturnItemInput], - "token": "abc123" + "cancel_url": "xyz789", + "error_url": "abc123", + "return_url": "xyz789" } ``` -### RequestNegotiableQuoteInput +### PayflowLinkMode -Defines properties of a negotiable quote request. +Indicates the mode for payment. Applies to the Payflow Link and Payments Advanced payment methods. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | -| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | +| Enum Value | Description | +|------------|-------------| +| `TEST` | | +| `LIVE` | | #### Example ```json -{ - "cart_id": "4", - "comment": NegotiableQuoteCommentInput, - "is_draft": false, - "quote_name": "xyz789" -} +""TEST"" ``` -### RequestNegotiableQuoteOutput +### PayflowLinkToken -Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. +Contains information used to generate PayPal iframe for transaction. Applies to Payflow Link and Payments Advanced payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | +| `mode` - [`PayflowLinkMode`](#payflowlinkmode) | The mode for the Payflow transaction. | +| `paypal_url` - [`String`](#string) | The PayPal URL used for requesting a Payflow form. | +| `secure_token` - [`String`](#string) | The secure token generated by PayPal. | +| `secure_token_id` - [`String`](#string) | The secure token ID generated by PayPal. | #### Example ```json -{"quote": NegotiableQuote} +{ + "mode": "TEST", + "paypal_url": "xyz789", + "secure_token": "abc123", + "secure_token_id": "abc123" +} ``` -### RequestNegotiableQuoteTemplateInput +### PayflowLinkTokenInput -Defines properties of a negotiable quote template request. +Contains information required to fetch payment token information for the Payflow Link and Payments Advanced payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | #### Example ```json -{"cart_id": 4} +{"cart_id": "abc123"} ``` -### RequestReturnInput +### PayflowProInput -Contains information needed to start a return request. +Contains input for the Payflow Pro and Payments Pro payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | +| `cc_details` - [`CreditCardDetailsInput!`](#creditcarddetailsinput) | Required input for credit card related information. | +| `is_active_payment_token_enabler` - [`Boolean`](#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 ```json { - "comment_text": "xyz789", - "contact_email": "abc123", - "items": [RequestReturnItemInput], - "order_uid": 4 + "cc_details": CreditCardDetailsInput, + "is_active_payment_token_enabler": false } ``` -### RequestReturnItemInput +### PayflowProResponseInput -Contains details about an item to be returned. +Input required to complete payment. Applies to Payflow Pro and Payments Pro payment methods. #### Input Fields | Input Field | Description | |-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | -| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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. | +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `paypal_payload` - [`String!`](#string) | The payload returned from PayPal. | #### Example ```json { - "entered_custom_attributes": [ - EnteredCustomAttributeInput - ], - "order_item_uid": 4, - "quantity_to_return": 123.45, - "selected_custom_attributes": [ - SelectedCustomAttributeInput - ] + "cart_id": "xyz789", + "paypal_payload": "xyz789" } ``` -### RequestReturnOutput - -Contains the response to a return request. +### PayflowProResponseOutput #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | Details about a single return request. | -| `returns` - [`Returns`](#returns) | An array of return requests. | +| `cart` - [`Cart!`](#cart) | The cart with the updated selected payment method. | #### Example ```json -{ - "return": Return, - "returns": Returns -} +{"cart": Cart} ``` -### RequisitionList +### PayflowProTokenInput -Defines the contents of a requisition list. +Contains input required to fetch payment token information for the Payflow Pro and Payments Pro payment methods. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `description` - [`String`](#string) | Optional text that describes the requisition list. | -| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. *(Deprecated: Deprecated. Use requisition_list_items instead. Will be removed in a future release.)* | -| `items_count` - [`Int!`](#int) | The number of items in the list. | -| `name` - [`String!`](#string) | The requisition list name. | -| `requisition_list_items` - [`RequisitionListItems`](#requisitionlistitems) | An array of products added to the requisition list. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | -| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `urls` - [`PayflowProUrlInput!`](#payflowprourlinput) | A set of relative URLs that PayPal uses for callback. | #### Example ```json { - "description": "abc123", - "items": RequistionListItems, - "items_count": 123, - "name": "xyz789", - "requisition_list_items": RequisitionListItems, - "uid": "4", - "updated_at": "abc123" + "cart_id": "abc123", + "urls": PayflowProUrlInput } ``` -### RequisitionListFilterInput +### PayflowProUrlInput -Defines requisition list filters. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | +| `cancel_url` - [`String!`](#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!`](#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!`](#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 ```json { - "name": FilterMatchTypeInput, - "uids": FilterEqualTypeInput + "cancel_url": "abc123", + "error_url": "abc123", + "return_url": "abc123" } ``` -### RequisitionListItemInterface +### PaymentConfigItem -The interface for requisition list items. +Contains payment fields that are common to all types of payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The amount added. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | #### Possible Types -| RequisitionListItemInterface Types | +| PaymentConfigItem Types | |----------------| -| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | -| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | -| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | +| [`HostedFieldsConfig`](#hostedfieldsconfig) | +| [`SmartButtonsConfig`](#smartbuttonsconfig) | +| [`ApplePayConfig`](#applepayconfig) | +| [`GooglePayConfig`](#googlepayconfig) | +| [`FastlaneConfig`](#fastlaneconfig) | #### Example ```json { - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "code": "xyz789", + "is_visible": true, + "payment_intent": "abc123", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "title": "abc123" } ``` -### RequisitionListItems +### PaymentConfigOutput -Contains an array of items added to a requisition list. +Retrieves the payment configuration for a given location #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](#int) | The number of pages returned. | +| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | +| `fastlane` - [`FastlaneConfig`](#fastlaneconfig) | Fastlane payment method configuration | +| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example ```json { - "items": [RequisitionListItemInterface], - "page_info": SearchResultPageInfo, - "total_pages": 987 + "apple_pay": ApplePayConfig, + "fastlane": FastlaneConfig, + "google_pay": GooglePayConfig, + "hosted_fields": HostedFieldsConfig, + "smart_buttons": SmartButtonsConfig } ``` -### RequisitionListItemsInput +### PaymentLocation + +Defines the origin location for that payment request + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_DETAIL` | | +| `MINICART` | | +| `CART` | | +| `CHECKOUT` | | +| `START_OF_CHECKOUT` | | +| `ADMIN` | | + +#### Example + +```json +""PRODUCT_DETAIL"" +``` + + + +### PaymentMethodInput -Defines the items to add. +Defines the payment method. #### Input Fields | Input Field | Description | |-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | -| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](#float) | The quantity of the product to add. | -| `selected_options` - [`[String]`](#string) | Selected option IDs. | -| `sku` - [`String!`](#string) | The product SKU. | +| `braintree` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_ach_direct_debit` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_ach_direct_debit_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_applepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_cc_vault` - [`BraintreeCcVaultInput`](#braintreeccvaultinput) | | +| `braintree_googlepay_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `braintree_paypal` - [`BraintreeInput`](#braintreeinput) | | +| `braintree_paypal_vault` - [`BraintreeVaultInput`](#braintreevaultinput) | | +| `code` - [`String!`](#string) | The internal name for the payment method. | +| `hosted_pro` - [`HostedProInput`](#hostedproinput) | Required input for PayPal Hosted pro payments. | +| `payflow_express` - [`PayflowExpressInput`](#payflowexpressinput) | Required input for Payflow Express Checkout payments. | +| `payflow_link` - [`PayflowLinkInput`](#payflowlinkinput) | Required input for PayPal Payflow Link and Payments Advanced payments. | +| `payflowpro` - [`PayflowProInput`](#payflowproinput) | Required input for PayPal Payflow Pro and Payment Pro payments. | +| `payflowpro_cc_vault` - [`VaultTokenInput`](#vaulttokeninput) | Required input for PayPal Payflow Pro vault payments. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](#fastlanemethodinput) | Required input for fastlane | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | +| `paypal_express` - [`PaypalExpressInput`](#paypalexpressinput) | Required input for Express Checkout and Payments Standard payments. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["xyz789"], - "sku": "abc123" + "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": "xyz789", + "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": "abc123" } ``` -### RequisitionLists +### PaymentOrderOutput -Defines customer requisition lists. +Contains the payment order details #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json { - "items": [RequisitionList], - "page_info": SearchResultPageInfo, - "total_count": 123 + "id": "xyz789", + "mp_order_id": "xyz789", + "payment_source_details": PaymentSourceDetails, + "status": "abc123" } ``` -### RequistionListItems - -Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release. +### PaymentSDKParamsItem #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](#int) | The number of pages returned. | +| `code` - [`String`](#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | #### Example ```json { - "items": [RequisitionListItemInterface], - "page_info": SearchResultPageInfo, - "total_pages": 123 + "code": "xyz789", + "params": [SDKParams] } ``` -### Return - -Contains details about a return. +### PaymentSourceDetails #### Fields | Field Name | Description | |------------|-------------| -| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | -| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | -| `created_at` - [`String!`](#string) | The date the return was requested. | -| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | -| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | -| `number` - [`String!`](#string) | A human-readable return number. | -| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | -| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | -| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | -| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| `card` - [`Card`](#card) | Details about the card used on the order | #### Example ```json -{ - "available_shipping_carriers": [ReturnShippingCarrier], - "comments": [ReturnComment], - "created_at": "abc123", - "customer": ReturnCustomer, - "items": [ReturnItem], - "number": "abc123", - "order": CustomerOrder, - "shipping": ReturnShipping, - "status": "PENDING", - "uid": 4 -} +{"card": Card} ``` -### ReturnComment +### PaymentSourceInput -Contains details about a return comment. +The payment source information -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `author_name` - [`String!`](#string) | The name or author who posted the comment. | -| `created_at` - [`String!`](#string) | The date and time the comment was posted. | -| `text` - [`String!`](#string) | The contents of the comment. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | +| Input Field | Description | +|-------------|-------------| +| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | #### Example ```json -{ - "author_name": "abc123", - "created_at": "xyz789", - "text": "xyz789", - "uid": 4 -} +{"card": CardPaymentSourceInput} ``` -### ReturnCustomAttribute +### PaymentSourceOutput -Contains details about a `ReturnCustomerAttribute` object. +The payment source information #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | A description of the attribute. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | -| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | +| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | #### Example ```json -{ - "label": "xyz789", - "uid": "4", - "value": "xyz789" -} +{"card": CardPaymentSourceOutput} ``` -### ReturnCustomer +### PaymentToken -The customer information for the return. +The stored payment method available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the customer. | -| `firstname` - [`String`](#string) | The first name of the customer. | -| `lastname` - [`String`](#string) | The last name of the customer. | +| `details` - [`String`](#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](#string) | The public hash of the token. | +| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "email": "abc123", - "firstname": "abc123", - "lastname": "xyz789" + "details": "abc123", + "payment_method_code": "abc123", + "public_hash": "abc123", + "type": "card" } ``` -### ReturnItem +### PaymentTokenTypeEnum -Contains details about a product being returned. +The list of available payment token types. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. *(Deprecated: Use custom_attributesV2 instead.)* | -| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | -| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | +| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | #### Example ```json -{ - "custom_attributes": [ReturnCustomAttribute], - "custom_attributesV2": [AttributeValueInterface], - "order_item": OrderItemInterface, - "quantity": 123.45, - "request_quantity": 123.45, - "status": "PENDING", - "uid": "4" -} +""card"" ``` -### ReturnItemAttributeMetadata - -Return Item attribute metadata. +### PaypalExpressInput -#### Fields +Contains required input for Express Checkout and Payments Standard payments. -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payer_id` - [`String!`](#string) | The unique ID of the PayPal user. | +| `token` - [`String!`](#string) | The token returned by the `createPaypalExpressToken` mutation. | #### Example ```json { - "code": 4, - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": false, - "is_unique": true, - "label": "xyz789", - "multiline_count": 987, - "options": [CustomAttributeOptionInterface], - "sort_order": 987, - "validate_rules": [ValidationRule] + "payer_id": "abc123", + "token": "abc123" } ``` -### ReturnItemStatus +### PaypalExpressTokenInput -#### Values +Defines the attributes required to receive a payment token for Express Checkout and Payments Standard payment methods. -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `RECEIVED` | | -| `APPROVED` | | -| `REJECTED` | | -| `DENIED` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `code` - [`String!`](#string) | The payment method code. | +| `express_button` - [`Boolean`](#boolean) | Indicates whether the buyer selected the quick checkout button. The default value is false. | +| `urls` - [`PaypalExpressUrlsInput!`](#paypalexpressurlsinput) | A set of relative URLs that PayPal uses in response to various actions during the authorization process. | +| `use_paypal_credit` - [`Boolean`](#boolean) | Indicates whether the buyer clicked the PayPal credit button. The default value is false. | #### Example ```json -""PENDING"" +{ + "cart_id": "abc123", + "code": "xyz789", + "express_button": true, + "urls": PaypalExpressUrlsInput, + "use_paypal_credit": true +} ``` -### ReturnShipping +### PaypalExpressTokenOutput -Contains details about the return shipping address. +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 Name | Description | |------------|-------------| -| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | -| `tracking` - [`[ReturnShippingTracking]`](#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. | +| `paypal_urls` - [`PaypalExpressUrlList`](#paypalexpressurllist) | A set of URLs that allow the buyer to authorize payment and adjust checkout details. | +| `token` - [`String`](#string) | The token returned by PayPal. | #### Example ```json { - "address": ReturnShippingAddress, - "tracking": [ReturnShippingTracking] + "paypal_urls": PaypalExpressUrlList, + "token": "xyz789" } ``` -### ReturnShippingAddress +### PaypalExpressUrlList -Contains details about the shipping address used for receiving returned items. +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 Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city for product returns. | -| `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](#country) | An object that defines the country for product returns. | -| `postcode` - [`String!`](#string) | The postal code for product returns. | -| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | -| `street` - [`[String]!`](#string) | The street address for product returns. | -| `telephone` - [`String`](#string) | The telephone number for product returns. | +| `edit` - [`String`](#string) | The PayPal URL that allows the buyer to edit their checkout details. | +| `start` - [`String`](#string) | The URL to the PayPal login page. | #### Example ```json { - "city": "xyz789", - "contact_name": "xyz789", - "country": Country, - "postcode": "abc123", - "region": Region, - "street": ["xyz789"], - "telephone": "xyz789" + "edit": "abc123", + "start": "xyz789" } ``` -### ReturnShippingCarrier +### PaypalExpressUrlsInput -Contains details about the carrier on a return. +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 Fields -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | +| Input Field | Description | +|-------------|-------------| +| `cancel_url` - [`String!`](#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`](#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!`](#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`](#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 ```json { - "label": "xyz789", - "uid": "4" + "cancel_url": "xyz789", + "pending_url": "abc123", + "return_url": "xyz789", + "success_url": "xyz789" } ``` -### ReturnShippingTracking +### PhysicalProductInterface -Contains shipping and tracking details. +Contains attributes specific to tangible products. #### Fields | Field Name | Description | |------------|-------------| -| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | -| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | -| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Possible Types + +| PhysicalProductInterface Types | +|----------------| +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | #### Example ```json -{ - "carrier": ReturnShippingCarrier, - "status": ReturnShippingTrackingStatus, - "tracking_number": "xyz789", - "uid": "4" -} +{"weight": 123.45} ``` -### ReturnShippingTrackingStatus +### PickupLocation -Contains the status of a shipment. +Defines Pickup Location information. #### Fields | Field Name | Description | |------------|-------------| -| `text` - [`String!`](#string) | Text that describes the status. | -| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | +| `city` - [`String`](#string) | | +| `contact_name` - [`String`](#string) | | +| `country_id` - [`String`](#string) | | +| `description` - [`String`](#string) | | +| `email` - [`String`](#string) | | +| `fax` - [`String`](#string) | | +| `latitude` - [`Float`](#float) | | +| `longitude` - [`Float`](#float) | | +| `name` - [`String`](#string) | | +| `phone` - [`String`](#string) | | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | | +| `region` - [`String`](#string) | | +| `region_id` - [`Int`](#int) | | +| `street` - [`String`](#string) | | #### Example ```json -{"text": "abc123", "type": "INFORMATION"} +{ + "city": "xyz789", + "contact_name": "abc123", + "country_id": "xyz789", + "description": "abc123", + "email": "abc123", + "fax": "xyz789", + "latitude": 123.45, + "longitude": 987.65, + "name": "xyz789", + "phone": "xyz789", + "pickup_location_code": "xyz789", + "postcode": "xyz789", + "region": "xyz789", + "region_id": 987, + "street": "xyz789" +} ``` -### ReturnShippingTrackingStatusType +### PickupLocationFilterInput -#### Values +PickupLocationFilterInput defines the list of attributes and filters for the search. -| Enum Value | Description | -|------------|-------------| -| `INFORMATION` | | -| `ERROR` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | #### Example ```json -""INFORMATION"" +{ + "city": FilterTypeInput, + "country_id": FilterTypeInput, + "name": FilterTypeInput, + "pickup_location_code": FilterTypeInput, + "postcode": FilterTypeInput, + "region": FilterTypeInput, + "region_id": FilterTypeInput, + "street": FilterTypeInput +} ``` -### ReturnStatus +### PickupLocationSortInput -#### Values +PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `UNCONFIRMED` | | -| `AUTHORIZED` | | -| `PARTIALLY_AUTHORIZED` | | -| `RECEIVED` | | -| `PARTIALLY_RECEIVED` | | -| `APPROVED` | | -| `PARTIALLY_APPROVED` | | -| `REJECTED` | | -| `PARTIALLY_REJECTED` | | -| `DENIED` | | -| `PROCESSED_AND_CLOSED` | | -| `CLOSED` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | +| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | #### Example ```json -""PENDING"" +{ + "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" +} ``` -### Returns +### PickupLocations -Contains a list of customer return requests. +Top level object returned in a pickup locations search. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Return]`](#return) | A list of return requests. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | +| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](#int) | The number of products returned. | #### Example ```json { - "items": [Return], + "items": [PickupLocation], "page_info": SearchResultPageInfo, "total_count": 987 } @@ -5256,1637 +2768,1800 @@ Contains a list of customer return requests. -### RevokeCustomerTokenOutput +### PlaceNegotiableQuoteOrderInput + +Specifies the negotiable quote to convert to an order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"quote_uid": "4"} +``` + + + +### PlaceNegotiableQuoteOrderOutput -Contains the result of a request to revoke a customer token. +An output object that returns the generated order. #### Fields | Field Name | Description | |------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | +| `order` - [`Order!`](#order) | Contains the generated order number. | #### Example ```json -{"result": true} +{"order": Order} ``` -### RewardPoints +### PlaceOrderError -Contains details about a customer's reward points. +An error encountered while placing an order. #### Fields | Field Name | Description | |------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | -| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | -| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | +| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "balance": RewardPointsAmount, - "balance_history": [RewardPointsBalanceHistoryItem], - "exchange_rates": RewardPointsExchangeRates, - "subscription_status": RewardPointsSubscriptionStatus + "code": "CART_NOT_FOUND", + "message": "xyz789" } ``` -### RewardPointsAmount +### PlaceOrderErrorCodes -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | +| `CART_NOT_FOUND` | | +| `CART_NOT_ACTIVE` | | +| `GUEST_EMAIL_MISSING` | | +| `UNABLE_TO_PLACE_ORDER` | | +| `UNDEFINED` | | #### Example ```json -{"money": Money, "points": 123.45} +""CART_NOT_FOUND"" ``` -### RewardPointsBalanceHistoryItem +### PlaceOrderForPurchaseOrderInput -Contain details about the reward points transaction. +Specifies the purchase order to convert to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | -| `change_reason` - [`String!`](#string) | The reason the balance changed. | -| `date` - [`String!`](#string) | The date of the transaction. | -| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | #### Example ```json -{ - "balance": RewardPointsAmount, - "change_reason": "abc123", - "date": "abc123", - "points_change": 987.65 -} +{"purchase_order_uid": 4} ``` -### RewardPointsExchangeRates +### PlaceOrderForPurchaseOrderOutput -Lists the reward points exchange rates. The values depend on the customer group. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | -| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | +| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | #### Example ```json -{ - "earning": RewardPointsRate, - "redemption": RewardPointsRate -} +{"order": CustomerOrder} ``` -### RewardPointsRate +### PlaceOrderInput -Contains details about customer's reward points rate. +Specifies the quote to be converted to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `currency_amount` - [`Float!`](#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!`](#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. | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -{"currency_amount": 123.45, "points": 987.65} +{"cart_id": "abc123"} ``` -### RewardPointsSubscriptionStatus +### PlaceOrderOutput -Indicates whether the customer subscribes to reward points emails. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | -| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | +| `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place order errors. | +| `order` - [`Order`](#order) | The ID of the order. *(Deprecated: Use `orderV2` instead.)* | +| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | #### Example ```json { - "balance_updates": "SUBSCRIBED", - "points_expiration_notifications": "SUBSCRIBED" + "errors": [PlaceOrderError], + "order": Order, + "orderV2": CustomerOrder } ``` -### RewardPointsSubscriptionStatusesEnum +### PlacePurchaseOrderInput -#### Values +Specifies the quote to be converted to a purchase order. -| Enum Value | Description | -|------------|-------------| -| `SUBSCRIBED` | | -| `NOT_SUBSCRIBED` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -""SUBSCRIBED"" +{"cart_id": "xyz789"} ``` -### RoutableInterface +### PlacePurchaseOrderOutput -Routable entities serve as the model for a rendered page. +Contains the results of the request to place a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | - -#### Possible Types - -| RoutableInterface Types | -|----------------| -| [`CmsPage`](#cmspage) | -| [`CategoryTree`](#categorytree) | -| [`VirtualProduct`](#virtualproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`RoutableUrl`](#routableurl) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`BundleProduct`](#bundleproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | +| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | #### Example ```json -{ - "redirect_code": 123, - "relative_url": "xyz789", - "type": "CMS_PAGE" -} +{"purchase_order": PurchaseOrder} ``` -### RoutableUrl +### Price -Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity. +Deprecated. Use `ProductPrice` instead. Defines the price of a product as well as any tax-related adjustments. #### Fields | Field Name | Description | |------------|-------------| -| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | -| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | An array that provides information about tax, weee, or weee_tax adjustments. *(Deprecated: Use `ProductPrice` instead.)* | +| `amount` - [`Money`](#money) | The price of a product plus a three-letter currency code. *(Deprecated: Use `ProductPrice` instead.)* | #### Example ```json { - "redirect_code": 987, - "relative_url": "xyz789", - "type": "CMS_PAGE" + "adjustments": [PriceAdjustment], + "amount": Money } ``` -### SDKParams +### PriceAdjustment -Defines the name and value of a SDK parameter +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 Name | Description | |------------|-------------| -| `name` - [`String`](#string) | The name of the SDK parameter | -| `value` - [`String`](#string) | The value of the SDK parameter | +| `amount` - [`Money`](#money) | The amount of the price adjustment and its currency code. | +| `code` - [`PriceAdjustmentCodesEnum`](#priceadjustmentcodesenum) | Indicates whether the adjustment involves tax, weee, or weee_tax. *(Deprecated: `PriceAdjustment` is deprecated.)* | +| `description` - [`PriceAdjustmentDescriptionEnum`](#priceadjustmentdescriptionenum) | Indicates whether the entity described by the code attribute is included or excluded from the adjustment. *(Deprecated: `PriceAdjustment` is deprecated.)* | #### Example ```json { - "name": "xyz789", - "value": "xyz789" + "amount": Money, + "code": "TAX", + "description": "INCLUDED" } ``` -### SalesCommentItem +### PriceAdjustmentCodesEnum -Contains details about a comment. +`PriceAdjustment.code` is deprecated. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `message` - [`String!`](#string) | The text of the message. | -| `timestamp` - [`String!`](#string) | The timestamp of the comment. | +| `TAX` | *(Deprecated: `PriceAdjustmentCodesEnum` is deprecated. Tax is included or excluded in the price. Tax is not shown separately in Catalog.)* | +| `WEEE` | *(Deprecated: WEEE code is deprecated. Use `fixed_product_taxes.label` instead.)* | +| `WEEE_TAX` | *(Deprecated: Use `fixed_product_taxes` instead. Tax is included or excluded in price. The tax is not shown separtely in Catalog.)* | #### Example ```json -{ - "message": "abc123", - "timestamp": "xyz789" -} +""TAX"" ``` -### ScopeTypeEnum +### PriceAdjustmentDescriptionEnum -This enumeration defines the scope type for customer orders. +`PriceAdjustmentDescriptionEnum` is deprecated. States whether a price adjustment is included or excluded. #### Values | Enum Value | Description | |------------|-------------| -| `GLOBAL` | | -| `WEBSITE` | | -| `STORE` | | +| `INCLUDED` | | +| `EXCLUDED` | | #### Example ```json -""GLOBAL"" +""INCLUDED"" ``` -### SearchResultPageInfo +### PriceDetails -Provides navigation for the query response. +Can be used to retrieve the main price details in case of bundle product #### Fields | Field Name | Description | |------------|-------------| -| `current_page` - [`Int`](#int) | The specific page to return. | -| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](#int) | The total number of pages in the response. | +| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](#float) | The regular price of the main product | #### Example ```json -{"current_page": 987, "page_size": 987, "total_pages": 987} +{ + "discount_percentage": 123.45, + "main_final_price": 987.65, + "main_price": 123.45 +} ``` -### SearchSuggestion +### PriceRange -A string that contains search suggestion +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 Name | Description | |------------|-------------| -| `search` - [`String!`](#string) | The search suggestion of existing product. | +| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | +| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | #### Example ```json -{"search": "xyz789"} +{ + "maximum_price": ProductPrice, + "minimum_price": ProductPrice +} ``` -### SelectedBundleOption +### PriceTypeEnum -Contains details about a selected bundle option. +Defines the price type. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | -| `label` - [`String!`](#string) | The display name of the selected bundle product option. | -| `type` - [`String!`](#string) | The type of selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | -| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | +| `FIXED` | | +| `PERCENT` | | +| `DYNAMIC` | | #### Example ```json -{ - "id": 987, - "label": "abc123", - "type": "abc123", - "uid": "4", - "values": [SelectedBundleOptionValue] -} +""FIXED"" ``` -### SelectedBundleOptionValue +### PriceViewEnum -Contains details about a value for a selected bundle option. +Defines whether a bundle product's price is displayed as the lowest possible value or as a range. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `id` - [`Int!`](#int) | Use `uid` instead | -| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `original_price` - [`Money!`](#money) | The original price of the value for the selected bundle product option. | -| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | -| `priceV2` - [`Money!`](#money) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | +| `PRICE_RANGE` | | +| `AS_LOW_AS` | | #### Example ```json -{ - "id": 123, - "label": "abc123", - "original_price": Money, - "price": 987.65, - "priceV2": Money, - "quantity": 123.45, - "uid": "4" -} +""PRICE_RANGE"" ``` -### SelectedConfigurableOption +### ProductAttribute -Contains details about a selected configurable option. +Contains a product attribute code and value. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | -| `option_label` - [`String!`](#string) | The display text for the option. | -| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | -| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | +| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](#string) | The display value of the attribute. | #### Example ```json { - "configurable_product_option_uid": 4, - "configurable_product_option_value_uid": "4", - "id": 123, - "option_label": "xyz789", - "value_id": 123, - "value_label": "xyz789" + "code": "xyz789", + "value": "abc123" } ``` -### SelectedCustomAttributeInput +### ProductAttributeFilterInput -Contains details about an attribute the buyer selected. +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. #### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`String!`](#string) | The unique ID for a selected custom attribute value. | +| `category_id` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Deprecated: use `category_uid` to filter product by category ID. | +| `category_uid` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by the unique ID for a `CategoryInterface` object. | +| `category_url_path` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter product by category URL path. | +| `description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Description | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Product Name | +| `price` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Attribute label: Price | +| `short_description` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Attribute label: Short Description | +| `sku` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Attribute label: SKU | +| `url_key` - [`FilterEqualTypeInput`](#filterequaltypeinput) | The part of the URL that identifies the product | #### Example ```json { - "attribute_code": "xyz789", - "value": "xyz789" + "category_id": FilterEqualTypeInput, + "category_uid": FilterEqualTypeInput, + "category_url_path": FilterEqualTypeInput, + "description": FilterMatchTypeInput, + "name": FilterMatchTypeInput, + "price": FilterRangeTypeInput, + "short_description": FilterMatchTypeInput, + "sku": FilterEqualTypeInput, + "url_key": FilterEqualTypeInput } ``` -### SelectedCustomizableOption +### ProductAttributeSortInput + +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 + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`SortEnum`](#sortenum) | Attribute label: Product Name | +| `position` - [`SortEnum`](#sortenum) | Sort by the position assigned to each product. | +| `price` - [`SortEnum`](#sortenum) | Attribute label: Price | +| `relevance` - [`SortEnum`](#sortenum) | Sort by the search relevance score (default). | + +#### Example + +```json +{"name": "ASC", "position": "ASC", "price": "ASC", "relevance": "ASC"} +``` + + + +### ProductCustomAttributes -Identifies a customized product that has been placed in a cart. +Product custom attributes #### Fields | Field Name | Description | |------------|-------------| -| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | -| `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | -| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | -| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | #### Example ```json { - "customizable_option_uid": 4, - "id": 123, - "is_required": false, - "label": "xyz789", - "sort_order": 987, - "type": "xyz789", - "values": [SelectedCustomizableOptionValue] + "errors": [AttributeMetadataError], + "items": [AttributeValueInterface] } ``` -### SelectedCustomizableOptionValue +### ProductDiscount -Identifies the value of the selected customized option. +Contains the discount applied to a product price. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | -| `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | -| `value` - [`String!`](#string) | The text identifying the selected value. | +| `amount_off` - [`Float`](#float) | The actual value of the discount. | +| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | + +#### Example + +```json +{"amount_off": 987.65, "percent_off": 123.45} +``` + + + +### ProductFilterInput + +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. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `category_id` - [`FilterTypeInput`](#filtertypeinput) | The category ID the product belongs to. | +| `country_of_manufacture` - [`FilterTypeInput`](#filtertypeinput) | The product's country of origin. | +| `created_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was created. | +| `custom_layout` - [`FilterTypeInput`](#filtertypeinput) | The name of a custom layout. | +| `custom_layout_update` - [`FilterTypeInput`](#filtertypeinput) | XML code that is applied as a layout update to the product page. | +| `description` - [`FilterTypeInput`](#filtertypeinput) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether a gift message is available. | +| `has_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether additional attributes have been created for the product. | +| `image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the main image on the product page. | +| `image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product image. | +| `is_returnable` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product can be returned. | +| `manufacturer` - [`FilterTypeInput`](#filtertypeinput) | A number representing the product's manufacturer. | +| `max_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric maximal price of the product. Do not include the currency code. | +| `meta_description` - [`FilterTypeInput`](#filtertypeinput) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`FilterTypeInput`](#filtertypeinput) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`FilterTypeInput`](#filtertypeinput) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_price` - [`FilterTypeInput`](#filtertypeinput) | The numeric minimal price of the product. Do not include the currency code. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | The product name. Customers use this name to identify the product. | +| `news_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `news_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date for new product listings. | +| `options_container` - [`FilterTypeInput`](#filtertypeinput) | If the product has multiple options, determines where they appear on the product page. | +| `or` - [`ProductFilterInput`](#productfilterinput) | The keyword required to perform a logical OR comparison. | +| `price` - [`FilterTypeInput`](#filtertypeinput) | The price of an item. | +| `required_options` - [`FilterTypeInput`](#filtertypeinput) | Indicates whether the product has required options. | +| `short_description` - [`FilterTypeInput`](#filtertypeinput) | A short description of the product. Its use depends on the theme. | +| `sku` - [`FilterTypeInput`](#filtertypeinput) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the small image, which is used on catalog pages. | +| `small_image_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's small image. | +| `special_from_date` - [`FilterTypeInput`](#filtertypeinput) | The beginning date that a product has a special price. | +| `special_price` - [`FilterTypeInput`](#filtertypeinput) | The discounted price of the product. Do not include the currency code. | +| `special_to_date` - [`FilterTypeInput`](#filtertypeinput) | The end date that a product has a special price. | +| `swatch_image` - [`FilterTypeInput`](#filtertypeinput) | The file name of a swatch image. | +| `thumbnail` - [`FilterTypeInput`](#filtertypeinput) | The relative path to the product's thumbnail image. | +| `thumbnail_label` - [`FilterTypeInput`](#filtertypeinput) | The label assigned to a product's thumbnail image. | +| `tier_price` - [`FilterTypeInput`](#filtertypeinput) | The price when tier pricing is in effect and the items purchased threshold has been reached. | +| `updated_at` - [`FilterTypeInput`](#filtertypeinput) | The timestamp indicating when the product was updated. | +| `url_key` - [`FilterTypeInput`](#filtertypeinput) | The part of the URL that identifies the product | +| `url_path` - [`FilterTypeInput`](#filtertypeinput) | | +| `weight` - [`FilterTypeInput`](#filtertypeinput) | The weight of the item, in units defined by the store. | #### Example ```json { - "customizable_option_value_uid": "4", - "id": 123, - "label": "xyz789", - "price": CartItemSelectedOptionValuePrice, - "value": "xyz789" + "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 } ``` -### SelectedPaymentMethod +### ProductImage -Describes the payment method the shopper selected. +Contains product image information, including the image URL and label. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `purchase_order_number` - [`String`](#string) | The purchase order number. | -| `title` - [`String!`](#string) | The payment method title. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](#string) | The URL of the product image or video. | #### Example ```json { - "code": "abc123", - "purchase_order_number": "xyz789", - "title": "xyz789" + "disabled": true, + "label": "abc123", + "position": 987, + "types": ["xyz789"], + "url": "xyz789" } ``` -### SelectedShippingMethod - -Contains details about the selected shipping method and carrier. +### ProductImageThumbnail -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | -| `method_title` - [`String!`](#string) | The label for the method code. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| `ITSELF` | Use thumbnail of product as image. | +| `PARENT` | Use thumbnail of product's parent as image. | #### Example ```json -{ - "amount": Money, - "base_amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", - "method_code": "abc123", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money -} +""ITSELF"" ``` -### SendEmailToFriendInput +### ProductInfoInput -Defines the referenced product and the email sender and recipients. +Product Information used for Pickup Locations search. #### Input Fields | Input Field | Description | |-------------|-------------| -| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | -| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | +| `sku` - [`String!`](#string) | Product SKU. | #### Example ```json -{ - "product_id": 987, - "recipients": [SendEmailToFriendRecipientInput], - "sender": SendEmailToFriendSenderInput -} +{"sku": "xyz789"} ``` -### SendEmailToFriendOutput +### ProductInterface -Contains information about the sender and recipients. +Contains fields that are common to all types of products. #### Fields | Field Name | Description | |------------|-------------| -| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | -| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of related products. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Possible Types + +| ProductInterface Types | +|----------------| +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | #### Example ```json { - "recipients": [SendEmailToFriendRecipient], - "sender": SendEmailToFriendSender + "attribute_set_id": 987, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 987, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": false, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "id": 123, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 987, + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "rating_summary": 987.65, + "related_products": [ProductInterface], + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "thumbnail": ProductImage, + "tier_price": 123.45, + "tier_prices": [ProductTierPrices], + "type_id": "abc123", + "uid": "4", + "updated_at": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website] } ``` -### SendEmailToFriendRecipient +### ProductLinks -An output object that contains information about the recipient. +An implementation of `ProductLinksInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | - -#### Example - -```json -{ - "email": "abc123", - "name": "abc123" -} -``` - - - -### SendEmailToFriendRecipientInput - -Contains details about a recipient. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the recipient. | -| `name` - [`String!`](#string) | The name of the recipient. | +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | #### Example ```json { - "email": "xyz789", - "name": "abc123" + "link_type": "xyz789", + "linked_product_sku": "xyz789", + "linked_product_type": "abc123", + "position": 987, + "sku": "xyz789" } ``` -### SendEmailToFriendSender +### ProductLinksInterface -An output object that contains information about the sender. +Contains information about linked products, including the link type and product type of each item. #### Fields | Field Name | Description | |------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | - -#### Example - -```json -{ - "email": "abc123", - "message": "xyz789", - "name": "xyz789" -} -``` - - - -### SendEmailToFriendSenderInput - -Contains details about the sender. +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the sender. | -| `message` - [`String!`](#string) | The text of the message to be sent. | -| `name` - [`String!`](#string) | The name of the sender. | +| ProductLinksInterface Types | +|----------------| +| [`ProductLinks`](#productlinks) | #### Example ```json { - "email": "xyz789", - "message": "abc123", - "name": "xyz789" + "link_type": "abc123", + "linked_product_sku": "xyz789", + "linked_product_type": "xyz789", + "position": 987, + "sku": "xyz789" } ``` -### SendFriendConfiguration +### ProductMediaGalleryEntriesContent -Contains details about the configuration of the Email to a Friend feature. +Contains an image in base64 format and basic information about the image. #### Fields | Field Name | Description | |------------|-------------| -| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | -| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | - -#### Example - -```json -{"enabled_for_customers": true, "enabled_for_guests": true} -``` - - - -### SendNegotiableQuoteForReviewInput - -Specifies which negotiable quote to send for review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `base64_encoded_data` - [`String`](#string) | The image in base64 format. | +| `name` - [`String`](#string) | The file name of the image. | +| `type` - [`String`](#string) | The MIME type of the file, such as image/png. | #### Example ```json -{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} +{ + "base64_encoded_data": "xyz789", + "name": "xyz789", + "type": "xyz789" +} ``` -### SendNegotiableQuoteForReviewOutput +### ProductMediaGalleryEntriesVideoContent -Contains the negotiable quote. +Contains a link to a video file and basic information about the video. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetBillingAddressOnCartInput - -Sets the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `media_type` - [`String`](#string) | Must be external-video. | +| `video_description` - [`String`](#string) | A description of the video. | +| `video_metadata` - [`String`](#string) | Optional data about the video. | +| `video_provider` - [`String`](#string) | Describes the video source. | +| `video_title` - [`String`](#string) | The title of the video. | +| `video_url` - [`String`](#string) | The URL to the video. | #### Example ```json { - "billing_address": BillingAddressInput, - "cart_id": "xyz789" + "media_type": "abc123", + "video_description": "abc123", + "video_metadata": "xyz789", + "video_provider": "xyz789", + "video_title": "xyz789", + "video_url": "abc123" } ``` -### SetBillingAddressOnCartOutput +### ProductPrice -Contains details about the cart after setting the billing address. +Represents a product price. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | +| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `regular_price` - [`Money!`](#money) | The regular price of the product. | #### Example ```json -{"cart": Cart} +{ + "discount": ProductDiscount, + "final_price": Money, + "fixed_product_taxes": [FixedProductTax], + "regular_price": Money +} ``` -### SetCartAsInactiveOutput +### ProductPrices -Sets the cart as inactive +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 Name | Description | |------------|-------------| -| `error` - [`String`](#string) | The error message returned after failing to set the cart as inactive | -| `success` - [`Boolean!`](#boolean) | Indicates whether the cart was set as inactive | +| `maximalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.maximum_price` instead.)* | +| `minimalPrice` - [`Price`](#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. *(Deprecated: Use `PriceRange.minimum_price` instead.)* | +| `regularPrice` - [`Price`](#price) | The base price of a product. *(Deprecated: Use `regular_price` from `PriceRange.minimum_price` or `PriceRange.maximum_price` instead.)* | #### Example ```json -{"error": "abc123", "success": true} +{ + "maximalPrice": Price, + "minimalPrice": Price, + "regularPrice": Price +} ``` -### SetGiftOptionsOnCartInput +### ProductReview -Defines the gift options applied to the cart. +Contains details of a product review. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | +| Field Name | Description | +|------------|-------------| +| `average_rating` - [`Float!`](#float) | The average of all ratings for this product. | +| `created_at` - [`String!`](#string) | The date the review was created. | +| `nickname` - [`String!`](#string) | The customer's nickname. Defaults to the customer name, if logged in. | +| `product` - [`ProductInterface!`](#productinterface) | The reviewed product. | +| `ratings_breakdown` - [`[ProductReviewRating]!`](#productreviewrating) | An array of ratings by rating category, such as quality, price, and value. | +| `summary` - [`String!`](#string) | The summary (title) of the review. | +| `text` - [`String!`](#string) | The review text. | #### Example ```json { - "cart_id": "xyz789", - "gift_message": GiftMessageInput, - "gift_receipt_included": false, - "gift_wrapping_id": "4", - "printed_card_included": true + "average_rating": 123.45, + "created_at": "abc123", + "nickname": "xyz789", + "product": ProductInterface, + "ratings_breakdown": [ProductReviewRating], + "summary": "abc123", + "text": "xyz789" } ``` -### SetGiftOptionsOnCartOutput +### ProductReviewRating -Contains the cart after gift options have been applied. +Contains data about a single aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `value` - [`String!`](#string) | The rating value given by customer. By default, possible values range from 1 to 5. | #### Example ```json -{"cart": Cart} +{ + "name": "abc123", + "value": "xyz789" +} ``` -### SetGuestEmailOnCartInput +### ProductReviewRatingInput -Defines the guest email and cart. +Contains the reviewer's rating for a single aspect of a review. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `email` - [`String!`](#string) | The email address of the guest. | +| `id` - [`String!`](#string) | An encoded rating ID. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | #### Example ```json { - "cart_id": "xyz789", - "email": "xyz789" + "id": "abc123", + "value_id": "xyz789" } ``` -### SetGuestEmailOnCartOutput +### ProductReviewRatingMetadata -Contains details about the cart after setting the email of a guest. +Contains details about a single aspect of a product review. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | +| `id` - [`String!`](#string) | An encoded rating ID. | +| `name` - [`String!`](#string) | The label assigned to an aspect of a product that is being rated, such as quality or price. | +| `values` - [`[ProductReviewRatingValueMetadata]!`](#productreviewratingvaluemetadata) | List of product review ratings sorted by position. | #### Example ```json -{"cart": Cart} +{ + "id": "xyz789", + "name": "abc123", + "values": [ProductReviewRatingValueMetadata] +} ``` -### SetLineItemNoteOutput +### ProductReviewRatingValueMetadata -Contains the updated negotiable quote. +Contains details about a single value in a product review. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | +| `value` - [`String!`](#string) | A ratings scale, such as the number of stars awarded. | +| `value_id` - [`String!`](#string) | An encoded rating value ID. | #### Example ```json -{"quote": NegotiableQuote} +{ + "value": "xyz789", + "value_id": "abc123" +} ``` -### SetNegotiableQuoteBillingAddressInput +### ProductReviewRatingsMetadata -Sets the billing address. +Contains an array of metadata about each aspect of a product review. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[ProductReviewRatingMetadata]!`](#productreviewratingmetadata) | An array of product reviews sorted by position. | #### Example ```json -{ - "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": "4" -} +{"items": [ProductReviewRatingMetadata]} ``` -### SetNegotiableQuoteBillingAddressOutput +### ProductReviews -Contains the negotiable quote. +Contains an array of product reviews. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | +| `items` - [`[ProductReview]!`](#productreview) | An array of product reviews. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | #### Example ```json -{"quote": NegotiableQuote} +{ + "items": [ProductReview], + "page_info": SearchResultPageInfo +} ``` -### SetNegotiableQuotePaymentMethodInput +### ProductStockStatus -Defines the payment method of the specified negotiable quote. +This enumeration states whether a product stock status is in stock or out of stock -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Enum Value | Description | +|------------|-------------| +| `IN_STOCK` | | +| `OUT_OF_STOCK` | | #### Example ```json -{ - "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": "4" -} +""IN_STOCK"" ``` -### SetNegotiableQuotePaymentMethodOutput +### ProductTierPrices -Contains details about the negotiable quote after setting the payment method. +Deprecated. Use `TierPrice` instead. Defines a tier price, which is a quantity discount offered to a specific customer group. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `customer_group_id` - [`String`](#string) | The ID of the customer group. *(Deprecated: Not relevant for the storefront.)* | +| `percentage_value` - [`Float`](#float) | The percentage discount of the item. *(Deprecated: Use `TierPrice.discount` instead.)* | +| `qty` - [`Float`](#float) | The number of items that must be purchased to qualify for tier pricing. *(Deprecated: Use `TierPrice.quantity` instead.)* | +| `value` - [`Float`](#float) | The price of the fixed price item. *(Deprecated: Use `TierPrice.final_price` instead.)* | +| `website_id` - [`Float`](#float) | The ID assigned to the website. *(Deprecated: Not relevant for the storefront.)* | #### Example ```json -{"quote": NegotiableQuote} +{ + "customer_group_id": "xyz789", + "percentage_value": 123.45, + "qty": 987.65, + "value": 123.45, + "website_id": 987.65 +} ``` -### SetNegotiableQuoteShippingAddressInput +### ProductVideo -Defines the shipping address to assign to the negotiable quote. +Contains information about a product video. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| Field Name | Description | +|------------|-------------| +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `types` - [`[String]`](#string) | Array of image types. It can have the following values: image, small_image, thumbnail. | +| `url` - [`String`](#string) | The URL of the product image or video. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json { - "customer_address_id": 4, - "quote_uid": 4, - "shipping_addresses": [ - NegotiableQuoteShippingAddressInput - ] + "disabled": false, + "label": "abc123", + "position": 123, + "types": ["abc123"], + "url": "abc123", + "video_content": ProductMediaGalleryEntriesVideoContent } ``` -### SetNegotiableQuoteShippingAddressOutput +### Products -Contains the negotiable quote. +Contains the results of a `products` query. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `aggregations` - [`[Aggregation]`](#aggregation) | A bucket that contains the attribute code and label for each filterable option. | +| `filters` - [`[LayerFilter]`](#layerfilter) | Layered navigation filters array. *(Deprecated: Use `aggregations` instead.)* | +| `items` - [`[ProductInterface]`](#productinterface) | An array of products that match the specified search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `sort_fields` - [`SortFields`](#sortfields) | An object that includes the default sort field and all available sort fields. | +| `suggestions` - [`[SearchSuggestion]`](#searchsuggestion) | An array of search suggestions for case when search query have no results. | +| `total_count` - [`Int`](#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 ```json -{"quote": NegotiableQuote} +{ + "aggregations": [Aggregation], + "filters": [LayerFilter], + "items": [ProductInterface], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "suggestions": [SearchSuggestion], + "total_count": 987 +} ``` -### SetNegotiableQuoteShippingMethodsInput +### PurchaseOrder -Defines the shipping method to apply to the negotiable quote. +Contains details about a purchase order. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | +| Field Name | Description | +|------------|-------------| +| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]!`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | +| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | +| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | +| `created_at` - [`String!`](#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | +| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | +| `number` - [`String!`](#string) | The purchase order number. | +| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | +| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | +| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | #### Example ```json { - "quote_uid": "4", - "shipping_methods": [ShippingMethodInput] + "approval_flow": [PurchaseOrderRuleApprovalFlow], + "available_actions": ["REJECT"], + "comments": [PurchaseOrderComment], + "created_at": "xyz789", + "created_by": Customer, + "history_log": [PurchaseOrderHistoryItem], + "number": "xyz789", + "order": CustomerOrder, + "quote": Cart, + "status": "PENDING", + "uid": 4, + "updated_at": "xyz789" } ``` -### SetNegotiableQuoteShippingMethodsOutput - -Contains the negotiable quote. +### PurchaseOrderAction -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `REJECT` | | +| `CANCEL` | | +| `VALIDATE` | | +| `APPROVE` | | +| `PLACE_ORDER` | | #### Example ```json -{"quote": NegotiableQuote} +""REJECT"" ``` -### SetNegotiableQuoteTemplateShippingAddressInput +### PurchaseOrderActionError -Defines the shipping address to assign to the negotiable quote template. +Contains details about a failed action. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{ - "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": 4 -} +{"message": "abc123", "type": "NOT_FOUND"} ``` -### SetPaymentMethodAndPlaceOrderInput +### PurchaseOrderApprovalFlowEvent -Applies a payment method to the quote. +Contains details about a single event in the approval flow of the purchase order. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | A formatted message. | +| `name` - [`String`](#string) | The approver name. | +| `role` - [`String`](#string) | The approver role. | +| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | +| `updated_at` - [`String`](#string) | The date and time the event was updated. | #### Example ```json { - "cart_id": "xyz789", - "payment_method": PaymentMethodInput + "message": "xyz789", + "name": "abc123", + "role": "xyz789", + "status": "PENDING", + "updated_at": "xyz789" } ``` -### SetPaymentMethodOnCartInput - -Applies a payment method to the cart. +### PurchaseOrderApprovalFlowItemStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVED` | | +| `REJECTED` | | #### Example ```json -{ - "cart_id": "xyz789", - "payment_method": PaymentMethodInput -} +""PENDING"" ``` -### SetPaymentMethodOnCartOutput +### PurchaseOrderApprovalRule -Contains details about the cart after setting the payment method. +Contains details about a purchase order approval rule. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | +| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | +| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](#string) | The name of the purchase order approval rule. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | #### Example ```json -{"cart": Cart} +{ + "applies_to_roles": [CompanyRole], + "approver_roles": [CompanyRole], + "condition": PurchaseOrderApprovalRuleConditionInterface, + "created_at": "abc123", + "created_by": "abc123", + "description": "abc123", + "name": "abc123", + "status": "ENABLED", + "uid": "4", + "updated_at": "xyz789" +} ``` -### SetShippingAddressesOnCartInput +### PurchaseOrderApprovalRuleConditionAmount -Specifies an array of addresses to use for shipping. +Contains approval rule condition details, including the amount to be evaluated. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | #### Example ```json { - "cart_id": "abc123", - "shipping_addresses": [ShippingAddressInput] + "amount": Money, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN" } ``` -### SetShippingAddressesOnCartOutput +### PurchaseOrderApprovalRuleConditionInterface -Contains details about the cart after setting the shipping addresses. +Purchase order rule condition details. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | + +#### Possible Types + +| PurchaseOrderApprovalRuleConditionInterface Types | +|----------------| +| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | +| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | #### Example ```json -{"cart": Cart} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} ``` -### SetShippingMethodsOnCartInput - -Applies one or shipping methods to the cart. +### PurchaseOrderApprovalRuleConditionOperator -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | +| Enum Value | Description | +|------------|-------------| +| `MORE_THAN` | | +| `LESS_THAN` | | +| `MORE_THAN_OR_EQUAL_TO` | | +| `LESS_THAN_OR_EQUAL_TO` | | #### Example ```json -{ - "cart_id": "abc123", - "shipping_methods": [ShippingMethodInput] -} +""MORE_THAN"" ``` -### SetShippingMethodsOnCartOutput +### PurchaseOrderApprovalRuleConditionQuantity -Contains details about the cart after setting the shipping methods. +Contains approval rule condition details, including the quantity to be evaluated. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{"cart": Cart} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} ``` -### ShareGiftRegistryInviteeInput +### PurchaseOrderApprovalRuleInput -Defines a gift registry invitee. +Defines a new purchase order approval rule. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String!`](#string) | The email address of the gift registry invitee. | -| `name` - [`String!`](#string) | The name of the gift registry invitee. | +| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](#string) | The purchase order approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "email": "xyz789", - "name": "abc123" + "applies_to": ["4"], + "approvers": [4], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "xyz789", + "name": "xyz789", + "status": "ENABLED" } ``` -### ShareGiftRegistryOutput +### PurchaseOrderApprovalRuleMetadata -Contains the results of a request to share a gift registry. +Contains metadata that can be used to render rule edit forms. #### Fields | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example ```json -{"is_shared": false} +{ + "available_applies_to": [CompanyRole], + "available_condition_currencies": [AvailableCurrency], + "available_requires_approval_from": [CompanyRole] +} ``` -### ShareGiftRegistrySenderInput - -Defines the sender of an invitation to view a gift registry. +### PurchaseOrderApprovalRuleStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `message` - [`String!`](#string) | A brief message from the sender. | -| `name` - [`String!`](#string) | The sender of the gift registry invitation. | +| Enum Value | Description | +|------------|-------------| +| `ENABLED` | | +| `DISABLED` | | #### Example ```json -{ - "message": "xyz789", - "name": "xyz789" -} +""ENABLED"" ``` -### ShipBundleItemsEnum - -Defines whether bundle items must be shipped together. +### PurchaseOrderApprovalRuleType #### Values | Enum Value | Description | |------------|-------------| -| `TOGETHER` | | -| `SEPARATELY` | | +| `GRAND_TOTAL` | | +| `SHIPPING_INCL_TAX` | | +| `NUMBER_OF_SKUS` | | #### Example ```json -""TOGETHER"" +""GRAND_TOTAL"" ``` -### ShipmentItem +### PurchaseOrderApprovalRules + +Contains the approval rules that the customer can see. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | #### Example ```json { - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "items": [PurchaseOrderApprovalRule], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### ShipmentItemInterface +### PurchaseOrderComment -Order shipment item details. +Contains details about a comment. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Possible Types - -| ShipmentItemInterface Types | -|----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | -| [`ShipmentItem`](#shipmentitem) | +| `author` - [`Customer`](#customer) | The user who left the comment. | +| `created_at` - [`String!`](#string) | The date and time when the comment was created. | +| `text` - [`String!`](#string) | The text of the comment. | +| `uid` - [`ID!`](#id) | A unique identifier of the comment. | #### Example ```json { - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "author": Customer, + "created_at": "xyz789", + "text": "xyz789", + "uid": "4" } ``` -### ShipmentTracking - -Contains order shipment tracking details. +### PurchaseOrderErrorType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | -| `number` - [`String`](#string) | The tracking number of the order shipment. | -| `title` - [`String!`](#string) | The shipment tracking title. | +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | #### Example ```json -{ - "carrier": "abc123", - "number": "abc123", - "title": "xyz789" -} +""NOT_FOUND"" ``` -### ShippingAddressInput +### PurchaseOrderHistoryItem -Defines a single shipping address. +Contains details about a status change. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | +| Field Name | Description | +|------------|-------------| +| `activity` - [`String!`](#string) | The activity type of the event. | +| `created_at` - [`String!`](#string) | The date and time when the event happened. | +| `message` - [`String!`](#string) | The message representation of the event. | +| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "address": CartAddressInput, - "customer_address_id": 123, - "customer_address_uid": "4", - "customer_notes": "abc123", - "pickup_location_code": "abc123" + "activity": "abc123", + "created_at": "abc123", + "message": "abc123", + "uid": "4" } ``` -### ShippingCartAddress +### PurchaseOrderRuleApprovalFlow -Contains shipping addresses and methods. +Contains details about approval roles applied to the purchase order and status changes. #### Fields | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | -| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `same_as_billing` - [`Boolean!`](#boolean) | Indicates whether the shipping address is same as billing address. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | +| `rule_name` - [`String!`](#string) | The name of the applied rule. | #### Example ```json { - "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": 123, - "items_weight": 987.65, - "lastname": "abc123", - "middlename": "xyz789", - "pickup_location_code": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", - "region": CartAddressRegion, - "same_as_billing": true, - "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", - "uid": "4", - "vat_id": "abc123" + "events": [PurchaseOrderApprovalFlowEvent], + "rule_name": "xyz789" } ``` -### ShippingDiscount - -Defines an individual shipping discount. This discount can be applied to shipping. +### PurchaseOrderStatus -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `PENDING` | | +| `APPROVAL_REQUIRED` | | +| `APPROVED` | | +| `ORDER_IN_PROGRESS` | | +| `ORDER_PLACED` | | +| `ORDER_FAILED` | | +| `REJECTED` | | +| `CANCELED` | | +| `APPROVED_PENDING_PAYMENT` | | #### Example ```json -{"amount": Money} +""PENDING"" ``` -### ShippingHandling +### PurchaseOrders -Contains details about shipping and handling costs. +Contains a list of purchase orders. #### Fields | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | -| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](#money) | The total amount for shipping. | +| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | #### Example ```json { - "amount_excluding_tax": Money, - "amount_including_tax": Money, - "discounts": [ShippingDiscount], - "taxes": [TaxItem], - "total_amount": Money + "items": [PurchaseOrder], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### ShippingMethodInput +### PurchaseOrdersActionInput -Defines the shipping carrier and method. +Defines which purchase orders to act on. #### Input Fields | Input Field | Description | |-------------|-------------| -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | -| `method_code` - [`String!`](#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. | +| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | #### Example ```json -{ - "carrier_code": "xyz789", - "method_code": "xyz789" -} +{"purchase_order_uids": [4]} ``` -### SimpleCartItem +### PurchaseOrdersActionOutput -An implementation for simple product cart items. +Returns a list of updated purchase orders and any error messages. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "xyz789", - "is_available": false, - "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": 123.45, - "uid": "4" + "errors": [PurchaseOrderActionError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### PurchaseOrdersFilterInput + +Defines the criteria to use to filter the list of purchase orders. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `require_my_approval` - [`Boolean`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | + +#### Example + +```json +{ + "company_purchase_orders": true, + "created_date": FilterRangeTypeInput, + "require_my_approval": true, + "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-q-s.md new file mode 100644 index 000000000..9049e86ba --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-q-s.md @@ -0,0 +1,4219 @@ +## Types + +### QuoteItemsSortInput + +Specifies the field to use for sorting quote items + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | +| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | + +#### Example + +```json +{"field": "ITEM_ID", "order": "ASC"} +``` + + + +### QuoteTemplateLineItemNoteInput + +Sets quote item note. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `note` - [`String`](#string) | The note text to be added. | +| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "item_id": 4, + "note": "xyz789", + "templateId": 4 +} +``` + + + +### QuoteTemplateNotificationMessage + +Contains a notification message for a negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The notification message. | +| `type` - [`String!`](#string) | The type of notification message. | + +#### Example + +```json +{ + "message": "xyz789", + "type": "abc123" +} +``` + + + +### ReCaptchaConfigOutput + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | +| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | + +#### Example + +```json +{ + "configurations": ReCaptchaConfiguration, + "is_enabled": true +} +``` + + + +### ReCaptchaConfiguration + +Contains reCAPTCHA form configuration details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `badge_position` - [`String`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `re_captcha_type` - [`ReCaptchaTypeEmum!`](#recaptchatypeemum) | | +| `technical_failure_message` - [`String!`](#string) | The message that appears when reCaptcha fails. | +| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | +| `validation_failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | + +#### Example + +```json +{ + "badge_position": "abc123", + "language_code": "xyz789", + "minimum_score": 987.65, + "re_captcha_type": "INVISIBLE", + "technical_failure_message": "xyz789", + "theme": "xyz789", + "validation_failure_message": "abc123", + "website_key": "abc123" +} +``` + + + +### ReCaptchaConfigurationV3 + +Contains reCAPTCHA V3-Invisible configuration details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | +| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | + +#### Example + +```json +{ + "badge_position": "abc123", + "failure_message": "xyz789", + "forms": ["PLACE_ORDER"], + "is_enabled": false, + "language_code": "abc123", + "minimum_score": 987.65, + "theme": "abc123", + "website_key": "abc123" +} +``` + + + +### ReCaptchaFormEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PLACE_ORDER` | | +| `CONTACT` | | +| `CUSTOMER_LOGIN` | | +| `CUSTOMER_FORGOT_PASSWORD` | | +| `CUSTOMER_CREATE` | | +| `CUSTOMER_EDIT` | | +| `NEWSLETTER` | | +| `PRODUCT_REVIEW` | | +| `SENDFRIEND` | | +| `BRAINTREE` | | +| `RESEND_CONFIRMATION_EMAIL` | | + +#### Example + +```json +""PLACE_ORDER"" +``` + + + +### ReCaptchaTypeEmum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INVISIBLE` | | +| `RECAPTCHA` | | +| `RECAPTCHA_V3` | | + +#### Example + +```json +""INVISIBLE"" +``` + + + +### Region + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | +| `id` - [`Int`](#int) | The unique ID for a `Region` object. | +| `name` - [`String`](#string) | The name of the region, such as Texas. | + +#### Example + +```json +{ + "code": "abc123", + "id": 987, + "name": "abc123" +} +``` + + + +### RemoveCouponFromCartInput + +Specifies the cart from which to remove a coupon. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### RemoveCouponFromCartOutput + +Contains details about the cart after removing a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveCouponsFromCartInput + +Remove coupons from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#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 + +```json +{ + "cart_id": "xyz789", + "coupon_codes": ["abc123"] +} +``` + + + +### RemoveGiftCardFromCartInput + +Defines the input required to run the `removeGiftCardFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "gift_card_code": "xyz789" +} +``` + + + +### RemoveGiftCardFromCartOutput + +Defines the possible output for the `removeGiftCardFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveGiftRegistryItemsOutput + +Contains the results of a request to remove an item from a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveGiftRegistryOutput + +Contains the results of a request to delete a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | + +#### Example + +```json +{"success": false} +``` + + + +### RemoveGiftRegistryRegistrantsOutput + +Contains the results of a request to delete a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveItemFromCartInput + +Specifies which items to remove from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_item_id` - [`Int`](#int) | Deprecated. Use `cart_item_uid` instead. | +| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_item_id": 987, + "cart_item_uid": "4" +} +``` + + + +### RemoveItemFromCartOutput + +Contains details about the cart after removing an item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after removing an item. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveNegotiableQuoteItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "quote_item_uids": ["4"], + "quote_uid": "4" +} +``` + + + +### RemoveNegotiableQuoteItemsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RemoveNegotiableQuoteTemplateItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"item_uids": ["4"], "template_id": 4} +``` + + + +### RemoveProductsFromCompareListInput + +Defines which products to remove from a compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": [4], "uid": 4} +``` + + + +### RemoveProductsFromWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### RemoveReturnTrackingInput + +Defines the tracking information to delete. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | + +#### Example + +```json +{"return_shipping_tracking_uid": 4} +``` + + + +### RemoveReturnTrackingOutput + +Contains the response after deleting tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Contains details about the modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### RemoveRewardPointsFromCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveStoreCreditFromCartInput + +Defines the input required to run the `removeStoreCreditFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### RemoveStoreCreditFromCartOutput + +Defines the possible output for the `removeStoreCreditFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RenameNegotiableQuoteInput + +Sets new name for a negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | +| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | +| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | + +#### Example + +```json +{ + "quote_comment": "xyz789", + "quote_name": "xyz789", + "quote_uid": "4" +} +``` + + + +### RenameNegotiableQuoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### ReorderItemsOutput + +Contains the cart and any errors after adding products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | + +#### Example + +```json +{ + "cart": Cart, + "userInputErrors": [CheckoutUserInputError] +} +``` + + + +### RequestGuestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `token` - [`String!`](#string) | Order token. | + +#### Example + +```json +{ + "comment_text": "abc123", + "contact_email": "abc123", + "items": [RequestReturnItemInput], + "token": "xyz789" +} +``` + + + +### RequestNegotiableQuoteInput + +Defines properties of a negotiable quote request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | +| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | + +#### Example + +```json +{ + "cart_id": 4, + "comment": NegotiableQuoteCommentInput, + "is_draft": false, + "quote_name": "abc123" +} +``` + + + +### RequestNegotiableQuoteOutput + +Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RequestNegotiableQuoteTemplateInput + +Defines properties of a negotiable quote template request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | + +#### Example + +```json +{"cart_id": "4"} +``` + + + +### RequestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | + +#### Example + +```json +{ + "comment_text": "xyz789", + "contact_email": "abc123", + "items": [RequestReturnItemInput], + "order_uid": "4" +} +``` + + + +### RequestReturnItemInput + +Contains details about an item to be returned. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | +| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 + +```json +{ + "entered_custom_attributes": [ + EnteredCustomAttributeInput + ], + "order_item_uid": "4", + "quantity_to_return": 123.45, + "selected_custom_attributes": [ + SelectedCustomAttributeInput + ] +} +``` + + + +### RequestReturnOutput + +Contains the response to a return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about a single return request. | +| `returns` - [`Returns`](#returns) | An array of return requests. | + +#### Example + +```json +{ + "return": Return, + "returns": Returns +} +``` + + + +### RequisitionList + +Defines the contents of a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `description` - [`String`](#string) | Optional text that describes the requisition list. | +| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. *(Deprecated: Deprecated. Use requisition_list_items instead. Will be removed in a future release.)* | +| `items_count` - [`Int!`](#int) | The number of items in the list. | +| `name` - [`String!`](#string) | The requisition list name. | +| `requisition_list_items` - [`RequisitionListItems`](#requisitionlistitems) | An array of products added to the requisition list. | +| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | + +#### Example + +```json +{ + "description": "xyz789", + "items": RequistionListItems, + "items_count": 123, + "name": "xyz789", + "requisition_list_items": RequisitionListItems, + "uid": "4", + "updated_at": "abc123" +} +``` + + + +### RequisitionListFilterInput + +Defines requisition list filters. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | + +#### Example + +```json +{ + "name": FilterMatchTypeInput, + "uids": FilterEqualTypeInput +} +``` + + + +### RequisitionListItemInterface + +The interface for requisition list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Possible Types + +| RequisitionListItemInterface Types | +|----------------| +| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | +| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | +| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | +| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### RequisitionListItems + +Contains an array of items added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_pages` - [`Int!`](#int) | The number of pages returned. | + +#### Example + +```json +{ + "items": [RequisitionListItemInterface], + "page_info": SearchResultPageInfo, + "total_pages": 123 +} +``` + + + +### RequisitionListItemsInput + +Defines the items to add. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | +| `quantity` - [`Float`](#float) | The quantity of the product to add. | +| `selected_options` - [`[String]`](#string) | Selected option IDs. | +| `sku` - [`String!`](#string) | The product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "xyz789", + "quantity": 123.45, + "selected_options": ["xyz789"], + "sku": "abc123" +} +``` + + + +### RequisitionLists + +Defines customer requisition lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The number of returned requisition lists. | + +#### Example + +```json +{ + "items": [RequisitionList], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### RequistionListItems + +Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed in a future release. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_pages` - [`Int!`](#int) | The number of pages returned. | + +#### Example + +```json +{ + "items": [RequisitionListItemInterface], + "page_info": SearchResultPageInfo, + "total_pages": 987 +} +``` + + + +### Return + +Contains details about a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | +| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | +| `created_at` - [`String!`](#string) | The date the return was requested. | +| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | +| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | +| `number` - [`String!`](#string) | A human-readable return number. | +| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | +| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | +| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | +| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "available_shipping_carriers": [ReturnShippingCarrier], + "comments": [ReturnComment], + "created_at": "abc123", + "customer": ReturnCustomer, + "items": [ReturnItem], + "number": "xyz789", + "order": CustomerOrder, + "shipping": ReturnShipping, + "status": "PENDING", + "uid": "4" +} +``` + + + +### ReturnComment + +Contains details about a return comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author_name` - [`String!`](#string) | The name or author who posted the comment. | +| `created_at` - [`String!`](#string) | The date and time the comment was posted. | +| `text` - [`String!`](#string) | The contents of the comment. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | + +#### Example + +```json +{ + "author_name": "xyz789", + "created_at": "abc123", + "text": "xyz789", + "uid": "4" +} +``` + + + +### ReturnCustomAttribute + +Contains details about a `ReturnCustomerAttribute` object. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the attribute. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnCustomAttribute` object. | +| `value` - [`String!`](#string) | A JSON-encoded value of the attribute. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": 4, + "value": "xyz789" +} +``` + + + +### ReturnCustomer + +The customer information for the return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the customer. | +| `firstname` - [`String`](#string) | The first name of the customer. | +| `lastname` - [`String`](#string) | The last name of the customer. | + +#### Example + +```json +{ + "email": "xyz789", + "firstname": "xyz789", + "lastname": "abc123" +} +``` + + + +### ReturnItem + +Contains details about a product being returned. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[ReturnCustomAttribute]`](#returncustomattribute) | Return item custom attributes that are visible on the storefront. *(Deprecated: Use custom_attributesV2 instead.)* | +| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | +| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | + +#### Example + +```json +{ + "custom_attributes": [ReturnCustomAttribute], + "custom_attributesV2": [AttributeValueInterface], + "order_item": OrderItemInterface, + "quantity": 123.45, + "request_quantity": 987.65, + "status": "PENDING", + "uid": 4 +} +``` + + + +### ReturnItemAttributeMetadata + +Return Item attribute metadata. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | + +#### Example + +```json +{ + "code": 4, + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": true, + "is_unique": true, + "label": "abc123", + "multiline_count": 987, + "options": [CustomAttributeOptionInterface], + "sort_order": 987, + "validate_rules": [ValidationRule] +} +``` + + + +### ReturnItemStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `RECEIVED` | | +| `APPROVED` | | +| `REJECTED` | | +| `DENIED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### ReturnShipping + +Contains details about the return shipping address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | +| `tracking` - [`[ReturnShippingTracking]`](#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. | + +#### Example + +```json +{ + "address": ReturnShippingAddress, + "tracking": [ReturnShippingTracking] +} +``` + + + +### ReturnShippingAddress + +Contains details about the shipping address used for receiving returned items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city for product returns. | +| `contact_name` - [`String`](#string) | The merchant's contact person. | +| `country` - [`Country!`](#country) | An object that defines the country for product returns. | +| `postcode` - [`String!`](#string) | The postal code for product returns. | +| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | +| `street` - [`[String]!`](#string) | The street address for product returns. | +| `telephone` - [`String`](#string) | The telephone number for product returns. | + +#### Example + +```json +{ + "city": "xyz789", + "contact_name": "xyz789", + "country": Country, + "postcode": "abc123", + "region": Region, + "street": ["abc123"], + "telephone": "xyz789" +} +``` + + + +### ReturnShippingCarrier + +Contains details about the carrier on a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the shipping carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | + +#### Example + +```json +{"label": "xyz789", "uid": 4} +``` + + + +### ReturnShippingTracking + +Contains shipping and tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | +| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | +| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | + +#### Example + +```json +{ + "carrier": ReturnShippingCarrier, + "status": ReturnShippingTrackingStatus, + "tracking_number": "xyz789", + "uid": "4" +} +``` + + + +### ReturnShippingTrackingStatus + +Contains the status of a shipment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `text` - [`String!`](#string) | Text that describes the status. | +| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | + +#### Example + +```json +{"text": "xyz789", "type": "INFORMATION"} +``` + + + +### ReturnShippingTrackingStatusType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INFORMATION` | | +| `ERROR` | | + +#### Example + +```json +""INFORMATION"" +``` + + + +### ReturnStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `UNCONFIRMED` | | +| `AUTHORIZED` | | +| `PARTIALLY_AUTHORIZED` | | +| `RECEIVED` | | +| `PARTIALLY_RECEIVED` | | +| `APPROVED` | | +| `PARTIALLY_APPROVED` | | +| `REJECTED` | | +| `PARTIALLY_REJECTED` | | +| `DENIED` | | +| `PROCESSED_AND_CLOSED` | | +| `CLOSED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### Returns + +Contains a list of customer return requests. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Return]`](#return) | A list of return requests. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The total number of return requests. | + +#### Example + +```json +{ + "items": [Return], + "page_info": SearchResultPageInfo, + "total_count": 987 +} +``` + + + +### RevokeCustomerTokenOutput + +Contains the result of a request to revoke a customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | + +#### Example + +```json +{"result": false} +``` + + + +### RewardPoints + +Contains details about a customer's reward points. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | +| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | +| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "balance_history": [RewardPointsBalanceHistoryItem], + "exchange_rates": RewardPointsExchangeRates, + "subscription_status": RewardPointsSubscriptionStatus +} +``` + + + +### RewardPointsAmount + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `money` - [`Money!`](#money) | The reward points amount in store currency. | +| `points` - [`Float!`](#float) | The reward points amount in points. | + +#### Example + +```json +{"money": Money, "points": 123.45} +``` + + + +### RewardPointsBalanceHistoryItem + +Contain details about the reward points transaction. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | +| `change_reason` - [`String!`](#string) | The reason the balance changed. | +| `date` - [`String!`](#string) | The date of the transaction. | +| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "change_reason": "xyz789", + "date": "abc123", + "points_change": 123.45 +} +``` + + + +### RewardPointsExchangeRates + +Lists the reward points exchange rates. The values depend on the customer group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | +| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | + +#### Example + +```json +{ + "earning": RewardPointsRate, + "redemption": RewardPointsRate +} +``` + + + +### RewardPointsRate + +Contains details about customer's reward points rate. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency_amount` - [`Float!`](#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!`](#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 + +```json +{"currency_amount": 987.65, "points": 987.65} +``` + + + +### RewardPointsSubscriptionStatus + +Indicates whether the customer subscribes to reward points emails. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | +| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | + +#### Example + +```json +{ + "balance_updates": "SUBSCRIBED", + "points_expiration_notifications": "SUBSCRIBED" +} +``` + + + +### RewardPointsSubscriptionStatusesEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUBSCRIBED` | | +| `NOT_SUBSCRIBED` | | + +#### Example + +```json +""SUBSCRIBED"" +``` + + + +### RoutableInterface + +Routable entities serve as the model for a rendered page. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Possible Types + +| RoutableInterface Types | +|----------------| +| [`CmsPage`](#cmspage) | +| [`CategoryTree`](#categorytree) | +| [`VirtualProduct`](#virtualproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`RoutableUrl`](#routableurl) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`BundleProduct`](#bundleproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | + +#### Example + +```json +{ + "redirect_code": 123, + "relative_url": "xyz789", + "type": "CMS_PAGE" +} +``` + + + +### RoutableUrl + +Default implementation of RoutableInterface. This type is returned when the URL is not linked to an entity. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `redirect_code` - [`Int!`](#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`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | + +#### Example + +```json +{ + "redirect_code": 987, + "relative_url": "abc123", + "type": "CMS_PAGE" +} +``` + + + +### SDKParams + +Defines the name and value of a SDK parameter + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | The name of the SDK parameter | +| `value` - [`String`](#string) | The value of the SDK parameter | + +#### Example + +```json +{ + "name": "abc123", + "value": "xyz789" +} +``` + + + +### SalesCommentItem + +Contains details about a comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The text of the message. | +| `timestamp` - [`String!`](#string) | The timestamp of the comment. | + +#### Example + +```json +{ + "message": "abc123", + "timestamp": "abc123" +} +``` + + + +### ScopeTypeEnum + +This enumeration defines the scope type for customer orders. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `GLOBAL` | | +| `WEBSITE` | | +| `STORE` | | + +#### Example + +```json +""GLOBAL"" +``` + + + +### SearchResultPageInfo + +Provides navigation for the query response. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `current_page` - [`Int`](#int) | The specific page to return. | +| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](#int) | The total number of pages in the response. | + +#### Example + +```json +{"current_page": 123, "page_size": 123, "total_pages": 987} +``` + + + +### SearchSuggestion + +A string that contains search suggestion + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `search` - [`String!`](#string) | The search suggestion of existing product. | + +#### Example + +```json +{"search": "xyz789"} +``` + + + +### SelectedBundleOption + +Contains details about a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`Int!`](#int) | *(Deprecated: Use `uid` instead)* | +| `label` - [`String!`](#string) | The display name of the selected bundle product option. | +| `type` - [`String!`](#string) | The type of selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | +| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | + +#### Example + +```json +{ + "id": 987, + "label": "xyz789", + "type": "abc123", + "uid": 4, + "values": [SelectedBundleOptionValue] +} +``` + + + +### SelectedBundleOptionValue + +Contains details about a value for a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`Int!`](#int) | Use `uid` instead | +| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | +| `original_price` - [`Money!`](#money) | The original price of the value for the selected bundle product option. | +| `price` - [`Float!`](#float) | The price of the value for the selected bundle product option. *(Deprecated: Use priceV2 instead.)* | +| `priceV2` - [`Money!`](#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | + +#### Example + +```json +{ + "id": 987, + "label": "abc123", + "original_price": Money, + "price": 123.45, + "priceV2": Money, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### SelectedConfigurableOption + +Contains details about a selected configurable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_uid` instead.)* | +| `option_label` - [`String!`](#string) | The display text for the option. | +| `value_id` - [`Int!`](#int) | *(Deprecated: Use `SelectedConfigurableOption.configurable_product_option_value_uid` instead.)* | +| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | + +#### Example + +```json +{ + "configurable_product_option_uid": "4", + "configurable_product_option_value_uid": "4", + "id": 987, + "option_label": "xyz789", + "value_id": 123, + "value_label": "xyz789" +} +``` + + + +### SelectedCustomAttributeInput + +Contains details about an attribute the buyer selected. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | +| `value` - [`String!`](#string) | The unique ID for a selected custom attribute value. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "value": "abc123" +} +``` + + + +### SelectedCustomizableOption + +Identifies a customized product that has been placed in a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOption.customizable_option_uid` instead.)* | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | +| `label` - [`String!`](#string) | The display name of the selected customizable option. | +| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | +| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | +| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | + +#### Example + +```json +{ + "customizable_option_uid": 4, + "id": 123, + "is_required": true, + "label": "abc123", + "sort_order": 123, + "type": "abc123", + "values": [SelectedCustomizableOptionValue] +} +``` + + + +### SelectedCustomizableOptionValue + +Identifies the value of the selected customized option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `id` - [`Int!`](#int) | *(Deprecated: Use `SelectedCustomizableOptionValue.customizable_option_value_uid` instead.)* | +| `label` - [`String!`](#string) | The display name of the selected value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `value` - [`String!`](#string) | The text identifying the selected value. | + +#### Example + +```json +{ + "customizable_option_value_uid": "4", + "id": 123, + "label": "xyz789", + "price": CartItemSelectedOptionValuePrice, + "value": "xyz789" +} +``` + + + +### SelectedPaymentMethod + +Describes the payment method the shopper selected. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `purchase_order_number` - [`String`](#string) | The purchase order number. | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "purchase_order_number": "xyz789", + "title": "xyz789" +} +``` + + + +### SelectedShippingMethod + +Contains details about the selected shipping method and carrier. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `base_amount` - [`Money`](#money) | *(Deprecated: The field should not be used on the storefront.)* | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | +| `method_title` - [`String!`](#string) | The label for the method code. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "amount": Money, + "base_amount": Money, + "carrier_code": "abc123", + "carrier_title": "abc123", + "method_code": "abc123", + "method_title": "xyz789", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### SendEmailToFriendInput + +Defines the referenced product and the email sender and recipients. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `product_id` - [`Int!`](#int) | The ID of the product that the sender is referencing. | +| `recipients` - [`[SendEmailToFriendRecipientInput]!`](#sendemailtofriendrecipientinput) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSenderInput!`](#sendemailtofriendsenderinput) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "product_id": 123, + "recipients": [SendEmailToFriendRecipientInput], + "sender": SendEmailToFriendSenderInput +} +``` + + + +### SendEmailToFriendOutput + +Contains information about the sender and recipients. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `recipients` - [`[SendEmailToFriendRecipient]`](#sendemailtofriendrecipient) | An array containing information about each recipient. | +| `sender` - [`SendEmailToFriendSender`](#sendemailtofriendsender) | Information about the customer and the content of the message. | + +#### Example + +```json +{ + "recipients": [SendEmailToFriendRecipient], + "sender": SendEmailToFriendSender +} +``` + + + +### SendEmailToFriendRecipient + +An output object that contains information about the recipient. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "abc123" +} +``` + + + +### SendEmailToFriendRecipientInput + +Contains details about a recipient. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the recipient. | +| `name` - [`String!`](#string) | The name of the recipient. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "xyz789" +} +``` + + + +### SendEmailToFriendSender + +An output object that contains information about the sender. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "abc123", + "message": "xyz789", + "name": "xyz789" +} +``` + + + +### SendEmailToFriendSenderInput + +Contains details about the sender. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the sender. | +| `message` - [`String!`](#string) | The text of the message to be sent. | +| `name` - [`String!`](#string) | The name of the sender. | + +#### Example + +```json +{ + "email": "xyz789", + "message": "abc123", + "name": "xyz789" +} +``` + + + +### SendFriendConfiguration + +Contains details about the configuration of the Email to a Friend feature. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `enabled_for_customers` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled. | +| `enabled_for_guests` - [`Boolean!`](#boolean) | Indicates whether the Email to a Friend feature is enabled for guests. | + +#### Example + +```json +{"enabled_for_customers": false, "enabled_for_guests": false} +``` + + + +### SendNegotiableQuoteForReviewInput + +Specifies which negotiable quote to send for review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "comment": NegotiableQuoteCommentInput, + "quote_uid": "4" +} +``` + + + +### SendNegotiableQuoteForReviewOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetBillingAddressOnCartInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{ + "billing_address": BillingAddressInput, + "cart_id": "xyz789" +} +``` + + + +### SetBillingAddressOnCartOutput + +Contains details about the cart after setting the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetCartAsInactiveOutput + +Sets the cart as inactive + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `error` - [`String`](#string) | The error message returned after failing to set the cart as inactive | +| `success` - [`Boolean!`](#boolean) | Indicates whether the cart was set as inactive | + +#### Example + +```json +{"error": "xyz789", "success": true} +``` + + + +### SetGiftOptionsOnCartInput + +Defines the gift options applied to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "gift_message": GiftMessageInput, + "gift_receipt_included": true, + "gift_wrapping_id": 4, + "printed_card_included": true +} +``` + + + +### SetGiftOptionsOnCartOutput + +Contains the cart after gift options have been applied. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The modified cart object. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGuestEmailOnCartInput + +Defines the guest email and cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `email` - [`String!`](#string) | The email address of the guest. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "email": "abc123" +} +``` + + + +### SetGuestEmailOnCartOutput + +Contains details about the cart after setting the email of a guest. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetLineItemNoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteBillingAddressInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "billing_address": NegotiableQuoteBillingAddressInput, + "quote_uid": "4" +} +``` + + + +### SetNegotiableQuoteBillingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuotePaymentMethodInput + +Defines the payment method of the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "payment_method": NegotiableQuotePaymentMethodInput, + "quote_uid": 4 +} +``` + + + +### SetNegotiableQuotePaymentMethodOutput + +Contains details about the negotiable quote after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingAddressInput + +Defines the shipping address to assign to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_address_id` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | + +#### Example + +```json +{ + "customer_address_id": "4", + "quote_uid": 4, + "shipping_addresses": [ + NegotiableQuoteShippingAddressInput + ] +} +``` + + + +### SetNegotiableQuoteShippingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingMethodsInput + +Defines the shipping method to apply to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | + +#### Example + +```json +{ + "quote_uid": "4", + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetNegotiableQuoteShippingMethodsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteTemplateShippingAddressInput + +Defines the shipping address to assign to the negotiable quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "shipping_address": NegotiableQuoteTemplateShippingAddressInput, + "template_id": "4" +} +``` + + + +### SetPaymentMethodAndPlaceOrderInput + +Applies a payment method to the quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartInput + +Applies a payment method to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartOutput + +Contains details about the cart after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingAddressesOnCartInput + +Specifies an array of addresses to use for shipping. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "shipping_addresses": [ShippingAddressInput] +} +``` + + + +### SetShippingAddressesOnCartOutput + +Contains details about the cart after setting the shipping addresses. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingMethodsOnCartInput + +Applies one or shipping methods to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | + +#### Example + +```json +{ + "cart_id": "abc123", + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetShippingMethodsOnCartOutput + +Contains details about the cart after setting the shipping methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ShareGiftRegistryInviteeInput + +Defines a gift registry invitee. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the gift registry invitee. | +| `name` - [`String!`](#string) | The name of the gift registry invitee. | + +#### Example + +```json +{ + "email": "xyz789", + "name": "abc123" +} +``` + + + +### ShareGiftRegistryOutput + +Contains the results of a request to share a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | + +#### Example + +```json +{"is_shared": false} +``` + + + +### ShareGiftRegistrySenderInput + +Defines the sender of an invitation to view a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `message` - [`String!`](#string) | A brief message from the sender. | +| `name` - [`String!`](#string) | The sender of the gift registry invitation. | + +#### Example + +```json +{ + "message": "xyz789", + "name": "abc123" +} +``` + + + +### ShipBundleItemsEnum + +Defines whether bundle items must be shipped together. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TOGETHER` | | +| `SEPARATELY` | | + +#### Example + +```json +""TOGETHER"" +``` + + + +### ShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 123.45 +} +``` + + + +### ShipmentItemInterface + +Order shipment item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Possible Types + +| ShipmentItemInterface Types | +|----------------| +| [`BundleShipmentItem`](#bundleshipmentitem) | +| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`ShipmentItem`](#shipmentitem) | + +#### Example + +```json +{ + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 123.45 +} +``` + + + +### ShipmentTracking + +Contains order shipment tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | +| `number` - [`String`](#string) | The tracking number of the order shipment. | +| `title` - [`String!`](#string) | The shipment tracking title. | + +#### Example + +```json +{ + "carrier": "abc123", + "number": "abc123", + "title": "xyz789" +} +``` + + + +### ShippingAddressInput + +Defines a single shipping address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 987, + "customer_address_uid": "4", + "customer_notes": "xyz789", + "pickup_location_code": "abc123" +} +``` + + + +### ShippingCartAddress + +Contains shipping addresses and methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items` - [`[CartItemQuantity]`](#cartitemquantity) | *(Deprecated: Use `cart_items_v2` instead.)* | +| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `items_weight` - [`Float`](#float) | *(Deprecated: This information should not be exposed on the frontend.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](#boolean) | Indicates whether the shipping address is same as billing address. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "available_shipping_methods": [AvailableShippingMethod], + "cart_items": [CartItemQuantity], + "cart_items_v2": [CartItemInterface], + "city": "abc123", + "company": "xyz789", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": "4", + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "abc123", + "id": 123, + "items_weight": 123.45, + "lastname": "xyz789", + "middlename": "abc123", + "pickup_location_code": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CartAddressRegion, + "same_as_billing": false, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "4", + "vat_id": "xyz789" +} +``` + + + +### ShippingDiscount + +Defines an individual shipping discount. This discount can be applied to shipping. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | + +#### Example + +```json +{"amount": Money} +``` + + + +### ShippingHandling + +Contains details about shipping and handling costs. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | +| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](#money) | The total amount for shipping. | + +#### Example + +```json +{ + "amount_excluding_tax": Money, + "amount_including_tax": Money, + "discounts": [ShippingDiscount], + "taxes": [TaxItem], + "total_amount": Money +} +``` + + + +### ShippingMethodInput + +Defines the shipping carrier and method. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | +| `method_code` - [`String!`](#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 + +```json +{ + "carrier_code": "abc123", + "method_code": "abc123" +} +``` + + + +### SimpleCartItem + +An implementation for simple product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "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, + "min_qty": 123.45, + "not_available_message": "abc123", + "note_from_buyer": [ItemNote], + "note_from_seller": [ItemNote], + "prices": CartItemPrices, + "product": ProductInterface, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### SimpleProduct + +Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "attribute_set_id": 123, + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": true, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "id": 987, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 987, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "rating_summary": 987.65, + "redirect_code": 123, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 987, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "abc123", + "special_price": 987.65, + "special_to_date": "abc123", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "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": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "xyz789", + "websites": [Website], + "weight": 987.65 +} +``` + + + +### SimpleProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### SimpleRequisitionListItem + +Contains details about simple products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "uid": 4 +} +``` + + + +### SimpleWishlistItem + +Contains a simple product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### SmartButtonMethodInput + +Smart button payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789" +} +``` + + + +### SmartButtonsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `app_switch_when_available` - [`Boolean`](#boolean) | Indicated whether to use App Switch on enabled mobile devices | +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "app_switch_when_available": false, + "button_styles": ButtonStyles, + "code": "xyz789", + "display_message": false, + "display_venmo": false, + "is_visible": false, + "message_styles": MessageStyles, + "payment_intent": "xyz789", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "abc123" +} +``` + + + +### SortEnum + +Indicates whether to return results in ascending or descending order. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ASC` | | +| `DESC` | | + +#### Example + +```json +""ASC"" +``` + + + +### SortField + +Defines a possible sort field. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label of the sort field. | +| `value` - [`String`](#string) | The attribute code of the sort field. | + +#### Example + +```json +{ + "label": "xyz789", + "value": "abc123" +} +``` + + + +### SortFields + +Contains a default value for sort fields and all available sort fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `default` - [`String`](#string) | The default sort field value. | +| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | + +#### Example + +```json +{ + "default": "abc123", + "options": [SortField] +} +``` + + + +### SortQuoteItemsEnum + +Specifies the field to use for sorting quote items + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ITEM_ID"" +``` + + + +### StoreConfig + +Contains information about a store's configuration. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `absolute_footer` - [`String`](#string) | Contains scripts that must be included in the HTML before the closing `` tag. | +| `allow_gift_receipt` - [`String`](#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`](#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`](#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`](#string) | Indicates whether guest users can write product reviews. Possible values: 1 (Yes) and 0 (No). | +| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | +| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | +| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | +| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `base_currency_code` - [`String`](#string) | The base currency code. | +| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | +| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | +| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | +| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | +| `braintree_3dsecure_allowspecific` - [`Boolean`](#boolean) | Braintree 3D Secure, should 3D Secure be used for specific countries. | +| `braintree_3dsecure_always_request_3ds` - [`Boolean`](#boolean) | Braintree 3D Secure, always request 3D Secure flag. | +| `braintree_3dsecure_specificcountry` - [`String`](#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`](#string) | Braintree 3D Secure, threshold above which 3D Secure should be requested. | +| `braintree_3dsecure_verify_3dsecure` - [`Boolean`](#boolean) | Braintree 3D Secure enabled/active status. | +| `braintree_ach_direct_debit_vault_active` - [`Boolean`](#boolean) | Braintree ACH vault status. | +| `braintree_applepay_merchant_name` - [`String`](#string) | Braintree Apple Pay merchant name. | +| `braintree_applepay_vault_active` - [`Boolean`](#boolean) | Braintree Apple Pay vault status. | +| `braintree_cc_vault_active` - [`String`](#string) | Braintree cc vault status. | +| `braintree_cc_vault_cvv` - [`Boolean`](#boolean) | Braintree cc vault CVV re-verification enabled status. | +| `braintree_environment` - [`String`](#string) | Braintree environment. | +| `braintree_googlepay_btn_color` - [`String`](#string) | Braintree Google Pay button color. | +| `braintree_googlepay_cctypes` - [`String`](#string) | Braintree Google Pay Card types supported. | +| `braintree_googlepay_merchant_id` - [`String`](#string) | Braintree Google Pay merchant ID. | +| `braintree_googlepay_vault_active` - [`Boolean`](#boolean) | Braintree Google Pay vault status. | +| `braintree_local_payment_allowed_methods` - [`String`](#string) | Braintree Local Payment Methods allowed payment methods. | +| `braintree_local_payment_fallback_button_text` - [`String`](#string) | Braintree Local Payment Methods fallback button text. | +| `braintree_local_payment_redirect_on_fail` - [`String`](#string) | Braintree Local Payment Methods redirect URL on failed payment. | +| `braintree_merchant_account_id` - [`String`](#string) | Braintree Merchant Account ID. | +| `braintree_paypal_button_location_cart_type_credit_color` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_credit_label` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style layout. | +| `braintree_paypal_button_location_cart_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo. | +| `braintree_paypal_button_location_cart_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging mini-cart & cart style logo position. | +| `braintree_paypal_button_location_cart_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging mini-cart & cart show status. | +| `braintree_paypal_button_location_cart_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | +| `braintree_paypal_button_location_cart_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later mini-cart & cart button show status. | +| `braintree_paypal_button_location_cart_type_paypal_color` - [`String`](#string) | Braintree PayPal mini-cart & cart button style color. | +| `braintree_paypal_button_location_cart_type_paypal_label` - [`String`](#string) | Braintree PayPal mini-cart & cart button style label. | +| `braintree_paypal_button_location_cart_type_paypal_shape` - [`String`](#string) | Braintree PayPal mini-cart & cart button style shape. | +| `braintree_paypal_button_location_cart_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal mini-cart & cart button show. | +| `braintree_paypal_button_location_checkout_type_credit_color` - [`String`](#string) | Braintree PayPal Credit checkout button style color. | +| `braintree_paypal_button_location_checkout_type_credit_label` - [`String`](#string) | Braintree PayPal Credit checkout button style label. | +| `braintree_paypal_button_location_checkout_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit checkout button show status. | +| `braintree_paypal_button_location_checkout_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style layout. | +| `braintree_paypal_button_location_checkout_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo. | +| `braintree_paypal_button_location_checkout_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style logo position. | +| `braintree_paypal_button_location_checkout_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging checkout show status. | +| `braintree_paypal_button_location_checkout_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging checkout style text color. | +| `braintree_paypal_button_location_checkout_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later checkout button style color. | +| `braintree_paypal_button_location_checkout_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later checkout button style label. | +| `braintree_paypal_button_location_checkout_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later checkout button show status. | +| `braintree_paypal_button_location_checkout_type_paypal_color` - [`String`](#string) | Braintree PayPal checkout button style color. | +| `braintree_paypal_button_location_checkout_type_paypal_label` - [`String`](#string) | Braintree PayPal checkout button style label. | +| `braintree_paypal_button_location_checkout_type_paypal_shape` - [`String`](#string) | Braintree PayPal checkout button style shape. | +| `braintree_paypal_button_location_checkout_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal checkout button show. | +| `braintree_paypal_button_location_productpage_type_credit_color` - [`String`](#string) | Braintree PayPal Credit PDP button style color. | +| `braintree_paypal_button_location_productpage_type_credit_label` - [`String`](#string) | Braintree PayPal Credit PDP button style label. | +| `braintree_paypal_button_location_productpage_type_credit_shape` - [`String`](#string) | Braintree PayPal Credit PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_credit_show` - [`Boolean`](#boolean) | Braintree PayPal Credit PDP button show status. | +| `braintree_paypal_button_location_productpage_type_messaging_layout` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style layout. | +| `braintree_paypal_button_location_productpage_type_messaging_logo` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo. | +| `braintree_paypal_button_location_productpage_type_messaging_logo_position` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style logo position. | +| `braintree_paypal_button_location_productpage_type_messaging_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later messaging PDP show status. | +| `braintree_paypal_button_location_productpage_type_messaging_text_color` - [`String`](#string) | Braintree PayPal Pay Later messaging PDP style text color. | +| `braintree_paypal_button_location_productpage_type_paylater_color` - [`String`](#string) | Braintree PayPal Pay Later PDP button style color. | +| `braintree_paypal_button_location_productpage_type_paylater_label` - [`String`](#string) | Braintree PayPal Pay Later PDP button style label. | +| `braintree_paypal_button_location_productpage_type_paylater_shape` - [`String`](#string) | Braintree PayPal Pay Later PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_paylater_show` - [`Boolean`](#boolean) | Braintree PayPal Pay Later PDP button show status. | +| `braintree_paypal_button_location_productpage_type_paypal_color` - [`String`](#string) | Braintree PayPal PDP button style color. | +| `braintree_paypal_button_location_productpage_type_paypal_label` - [`String`](#string) | Braintree PayPal PDP button style label. | +| `braintree_paypal_button_location_productpage_type_paypal_shape` - [`String`](#string) | Braintree PayPal PDP button style shape. | +| `braintree_paypal_button_location_productpage_type_paypal_show` - [`Boolean`](#boolean) | Braintree PayPal PDP button show. | +| `braintree_paypal_credit_uk_merchant_name` - [`String`](#string) | Braintree PayPal Credit Merchant Name on the FCA Register. | +| `braintree_paypal_display_on_shopping_cart` - [`Boolean`](#boolean) | Should display Braintree PayPal in mini-cart & cart? | +| `braintree_paypal_merchant_country` - [`String`](#string) | Braintree PayPal merchant's country. | +| `braintree_paypal_merchant_name_override` - [`String`](#string) | Braintree PayPal override for Merchant Name. | +| `braintree_paypal_require_billing_address` - [`Boolean`](#boolean) | Does Braintree PayPal require the customer's billing address? | +| `braintree_paypal_send_cart_line_items` - [`Boolean`](#boolean) | Does Braintree PayPal require the order line items? | +| `braintree_paypal_vault_active` - [`Boolean`](#boolean) | Braintree PayPal vault status. | +| `cart_expires_in_days` - [`Int`](#int) | checkout/cart/delete_quote_after: quote lifetime in days. | +| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | +| `cart_merge_preference` - [`String!`](#string) | Configuration data from checkout/cart/cart_merge_preference | +| `cart_printed_card` - [`String`](#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`](#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`](#string) | The default sort order of the search results list. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | +| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | +| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | +| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | +| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | +| `cms_home_page` - [`String`](#string) | The name of the CMS page that identifies the home page for the store. | +| `cms_no_cookies` - [`String`](#string) | A specific CMS page that displays when cookies are not enabled for the browser. | +| `cms_no_route` - [`String`](#string) | A specific CMS page that displays when a 404 'Page Not Found' error occurs. | +| `code` - [`String`](#string) | A code assigned to the store to identify it. *(Deprecated: Use `store_code` instead.)* | +| `configurable_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | +| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | +| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | +| `copyright` - [`String`](#string) | The copyright statement that appears at the bottom of each page. | +| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | +| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | +| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | +| `default_description` - [`String`](#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`](#string) | The default display currency code. | +| `default_keywords` - [`String`](#string) | A series of keywords that describe your store, each separated by a comma. | +| `default_title` - [`String`](#string) | The title that appears at the title bar of each page when viewed in a browser. | +| `demonotice` - [`Int`](#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!`](#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | +| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `front` - [`String`](#string) | The landing page that is associated with the base URL. | +| `graphql_share_customer_group` - [`Boolean`](#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | +| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | +| `grouped_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `head_includes` - [`String`](#string) | Scripts that must be included in the HTML before the closing `` tag. | +| `head_shortcut_icon` - [`String`](#string) | The small graphic image (favicon) that appears in the address bar and tab of the browser. | +| `header_logo_src` - [`String`](#string) | The path to the logo that appears in the header. | +| `id` - [`Int`](#int) | The ID number assigned to the store. *(Deprecated: Use `store_code` instead.)* | +| `is_checkout_agreements_enabled` - [`Boolean!`](#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | +| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | +| `list_mode` - [`String`](#string) | The format of the search results list. | +| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | +| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | +| `locale` - [`String`](#string) | The store locale. | +| `logo_alt` - [`String`](#string) | The Alt text that is associated with the logo. | +| `logo_height` - [`Int`](#int) | The height of the logo image, in pixels. | +| `logo_width` - [`Int`](#int) | The width of the logo image, in pixels. | +| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | +| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | +| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | +| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | +| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | +| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | +| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | +| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | +| `max_items_in_order_summary` - [`Int`](#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | +| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | +| `minicart_display` - [`Boolean`](#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](#int) | checkout/sidebar/count: maximum number of items to show in minicart. | +| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | +| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | +| `no_route` - [`String`](#string) | The default page that displays when a 404 'Page not Found' error occurs. | +| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | +| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/zero_tax | +| `payment_payflowpro_cc_vault_active` - [`String`](#string) | Payflow Pro vault status. | +| `printed_card_price` - [`String`](#string) | The default price of a printed card that accompanies an order. *(Deprecated: Use printed_card_priceV2 instead)* | +| `printed_card_priceV2` - [`Money`](#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates whether product reviews are enabled. Possible values: 1 (Yes) and 0 (No). | +| `product_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | +| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | +| `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | +| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | +| `root_category_id` - [`Int`](#int) | The ID of the root category. *(Deprecated: Use `root_category_uid` instead.)* | +| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | +| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | +| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | +| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | +| `send_friend` - [`SendFriendConfiguration`](#sendfriendconfiguration) | Email to a Friend configuration. | +| `share_active_segments` - [`Boolean`](#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | +| `share_applied_cart_rule` - [`Boolean`](#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | +| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `show_cms_breadcrumbs` - [`Int`](#int) | Indicates whether a breadcrumb trail appears on all CMS pages in the catalog. 0 (No) or 1 (Yes). | +| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `store_group_name` - [`String`](#string) | The label assigned to the store group. | +| `store_name` - [`String`](#string) | The label assigned to the store view. | +| `store_sort_order` - [`Int`](#int) | The store view sort order. | +| `timezone` - [`String`](#string) | The time zone of the store. | +| `title_prefix` - [`String`](#string) | A prefix that appears before the title to create a two- or three-part title. | +| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | +| `title_suffix` - [`String`](#string) | A suffix that appears after the title to create a two- or three-part title. | +| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](#id) | The unique ID for the website. | +| `website_id` - [`Int`](#int) | The ID number assigned to the website store. *(Deprecated: The field should not be used on the storefront.)* | +| `website_name` - [`String`](#string) | The label assigned to the website. | +| `weight_unit` - [`String`](#string) | The unit of weight. | +| `welcome` - [`String`](#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`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | +| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | +| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | + +#### Example + +```json +{ + "absolute_footer": "xyz789", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order_items": "xyz789", + "allow_guests_to_write_product_reviews": "xyz789", + "allow_items": "xyz789", + "allow_order": "abc123", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": true, + "base_currency_code": "abc123", + "base_link_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "abc123", + "base_url": "abc123", + "braintree_3dsecure_allowspecific": false, + "braintree_3dsecure_always_request_3ds": true, + "braintree_3dsecure_specificcountry": "xyz789", + "braintree_3dsecure_threshold_amount": "abc123", + "braintree_3dsecure_verify_3dsecure": true, + "braintree_ach_direct_debit_vault_active": true, + "braintree_applepay_merchant_name": "abc123", + "braintree_applepay_vault_active": true, + "braintree_cc_vault_active": "xyz789", + "braintree_cc_vault_cvv": false, + "braintree_environment": "xyz789", + "braintree_googlepay_btn_color": "xyz789", + "braintree_googlepay_cctypes": "abc123", + "braintree_googlepay_merchant_id": "abc123", + "braintree_googlepay_vault_active": false, + "braintree_local_payment_allowed_methods": "xyz789", + "braintree_local_payment_fallback_button_text": "xyz789", + "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": "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": 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": "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": "xyz789", + "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": 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": "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_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": 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": "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": "xyz789", + "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": true, + "braintree_paypal_merchant_country": "abc123", + "braintree_paypal_merchant_name_override": "abc123", + "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": "xyz789", + "cart_merge_preference": "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": "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": "xyz789", + "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_send_check_to": "abc123", + "check_money_order_sort_order": 123, + "check_money_order_title": "xyz789", + "cms_home_page": "abc123", + "cms_no_cookies": "abc123", + "cms_no_route": "abc123", + "code": "abc123", + "configurable_product_image": "ITSELF", + "configurable_thumbnail_source": "abc123", + "contact_enabled": true, + "copyright": "xyz789", + "countries_with_required_region": "xyz789", + "create_account_confirmation": true, + "customer_access_token_lifetime": 123.45, + "default_country": "abc123", + "default_description": "abc123", + "default_display_currency_code": "abc123", + "default_keywords": "abc123", + "default_title": "xyz789", + "demonotice": 987, + "display_product_prices_in_catalog": 123, + "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": 987, + "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": true, + "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": 123, + "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": "xyz789", + "list_per_page": 987, + "list_per_page_values": "xyz789", + "locale": "xyz789", + "logo_alt": "abc123", + "logo_height": 123, + "logo_width": 987, + "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": "abc123", + "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_review": "abc123", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": false, + "minicart_max_items": 987, + "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": true, + "orders_invoices_credit_memos_display_grandtotal": true, + "orders_invoices_credit_memos_display_price": 123, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "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": "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": "abc123", + "sales_printed_card": "abc123", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "abc123", + "secure_base_static_url": "xyz789", + "secure_base_url": "xyz789", + "send_friend": SendFriendConfiguration, + "share_active_segments": false, + "share_applied_cart_rule": true, + "shopping_cart_display_full_summary": true, + "shopping_cart_display_grand_total": false, + "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": 123, + "store_code": "4", + "store_group_code": 4, + "store_group_name": "xyz789", + "store_name": "xyz789", + "store_sort_order": 123, + "timezone": "xyz789", + "title_prefix": "abc123", + "title_separator": "abc123", + "title_suffix": "xyz789", + "use_store_in_url": true, + "website_code": 4, + "website_id": 987, + "website_name": "xyz789", + "weight_unit": "abc123", + "welcome": "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_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "xyz789" +} +``` + + + +### StorefrontProperties + +Indicates where an attribute can be displayed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of the attribute in the layered navigation block. | +| `use_in_layered_navigation` - [`UseInLayeredNavigationOptions`](#useinlayerednavigationoptions) | Indicates whether the attribute is filterable with results, without results, or not at all. | +| `use_in_product_listing` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed in product listings. | +| `use_in_search_results_layered_navigation` - [`Boolean`](#boolean) | Indicates whether the attribute can be used in layered navigation on search results pages. | +| `visible_on_catalog_pages` - [`Boolean`](#boolean) | Indicates whether the attribute is displayed on product pages. | + +#### Example + +```json +{ + "position": 123, + "use_in_layered_navigation": "NO", + "use_in_product_listing": true, + "use_in_search_results_layered_navigation": false, + "visible_on_catalog_pages": true +} +``` + + + +### String + +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 + +```json +"xyz789" +``` + + + +### SubmitNegotiableQuoteTemplateForReviewInput + +Specifies the quote template properties to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String`](#string) | A comment for the seller to review. | +| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | +| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "comment": "abc123", + "max_order_commitment": 987, + "min_order_commitment": 987, + "name": "abc123", + "reference_document_links": [ + NegotiableQuoteTemplateReferenceDocumentLinkInput + ], + "template_id": "4" +} +``` + + + +### SubscribeEmailToNewsletterOutput + +Contains the result of the `subscribeEmailToNewsletter` operation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | + +#### Example + +```json +{"status": "NOT_ACTIVE"} +``` + + + +### SubscriptionStatusesEnum + +Indicates the status of the request. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_ACTIVE` | | +| `SUBSCRIBED` | | +| `UNSUBSCRIBED` | | +| `UNCONFIRMED` | | + +#### Example + +```json +""NOT_ACTIVE"" +``` + + + +### SwatchData + +Describes the swatch type and a value. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `type` - [`String`](#string) | The type of swatch filter item: 1 - text; 2 - image. | +| `value` - [`String`](#string) | The value for the swatch item. It could be text or an image link. | + +#### Example + +```json +{ + "type": "abc123", + "value": "abc123" +} +``` + + + +### SwatchDataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Possible Types + +| SwatchDataInterface Types | +|----------------| +| [`ImageSwatchData`](#imageswatchdata) | +| [`TextSwatchData`](#textswatchdata) | +| [`ColorSwatchData`](#colorswatchdata) | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### SwatchInputTypeEnum + +Swatch attribute metadata input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `DROPDOWN` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `UNDEFINED` | | +| `VISUAL` | | +| `WEIGHT` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### SwatchLayerFilterItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items_count` - [`Int`](#int) | The count of items per filter. *(Deprecated: Use `AggregationOption.count` instead.)* | +| `label` - [`String`](#string) | The label for a filter. *(Deprecated: Use `AggregationOption.label` instead.)* | +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | +| `value_string` - [`String`](#string) | The value of a filter request variable to be used in query. *(Deprecated: Use `AggregationOption.value` instead.)* | + +#### Example + +```json +{ + "items_count": 987, + "label": "abc123", + "swatch_data": SwatchData, + "value_string": "xyz789" +} +``` + + + +### SwatchLayerFilterItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `swatch_data` - [`SwatchData`](#swatchdata) | Data required to render a swatch filter item. | + +#### Possible Types + +| SwatchLayerFilterItemInterface Types | +|----------------| +| [`SwatchLayerFilterItem`](#swatchlayerfilteritem) | + +#### Example + +```json +{"swatch_data": SwatchData} +``` + + + +### SyncPaymentOrderInput + +Synchronizes the payment order details + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `id` - [`String!`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cartId": "abc123", + "id": "xyz789" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-t-z.md new file mode 100644 index 000000000..cee58c94a --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-t-z.md @@ -0,0 +1,1614 @@ +## Types + +### TaxItem + +Contains tax item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `rate` - [`Float!`](#float) | The rate used to calculate the tax. | +| `title` - [`String!`](#string) | A title that describes the tax. | + +#### Example + +```json +{ + "amount": Money, + "rate": 987.65, + "title": "xyz789" +} +``` + + + +### TaxWrappingEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `DISPLAY_EXCLUDING_TAX` | | +| `DISPLAY_INCLUDING_TAX` | | +| `DISPLAY_TYPE_BOTH` | | + +#### Example + +```json +""DISPLAY_EXCLUDING_TAX"" +``` + + + +### TextSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{"value": "abc123"} +``` + + + +### ThreeDSMode + +3D Secure mode. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OFF` | | +| `SCA_WHEN_REQUIRED` | | +| `SCA_ALWAYS` | | + +#### Example + +```json +""OFF"" +``` + + + +### TierPrice + +Defines a price based on the quantity purchased. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount that this tier represents. | +| `final_price` - [`Money`](#money) | The price of the product at this tier. | +| `quantity` - [`Float`](#float) | The minimum number of items that must be purchased to qualify for this price tier. | + +#### Example + +```json +{ + "discount": ProductDiscount, + "final_price": Money, + "quantity": 987.65 +} +``` + + + +### UpdateCartItemsInput + +Modifies the specified items in the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_items` - [`[CartItemUpdateInput]!`](#cartitemupdateinput) | An array of items to be updated. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [CartItemUpdateInput] +} +``` + + + +### UpdateCartItemsOutput + +Contains details about the cart after updating items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after updating products. | +| `errors` - [`[CartUserInputError]!`](#cartuserinputerror) | Contains errors encountered while updating an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "errors": [CartUserInputError] +} +``` + + + +### UpdateCompanyOutput + +Contains the response to the request to update the company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyRoleOutput + +Contains the response to the request to update the company role. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `role` - [`CompanyRole!`](#companyrole) | The updated company role instance. | + +#### Example + +```json +{"role": CompanyRole} +``` + + + +### UpdateCompanyStructureOutput + +Contains the response to the request to update the company structure. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The updated company instance. | + +#### Example + +```json +{"company": Company} +``` + + + +### UpdateCompanyTeamOutput + +Contains the response to the request to update a company team. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `team` - [`CompanyTeam!`](#companyteam) | The updated company team instance. | + +#### Example + +```json +{"team": CompanyTeam} +``` + + + +### UpdateCompanyUserOutput + +Contains the response to the request to update the company user. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user` - [`Customer!`](#customer) | The updated company user instance. | + +#### Example + +```json +{"user": Customer} +``` + + + +### UpdateGiftRegistryInput + +Defines updates to a `GiftRegistry` object. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. Unspecified dynamic attributes are not changed. | +| `event_name` - [`String`](#string) | The updated name of the event. | +| `message` - [`String`](#string) | The updated message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings`](#giftregistryprivacysettings) | Indicates whether the gift registry is PRIVATE or PUBLIC. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The updated shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus`](#giftregistrystatus) | Indicates whether the gift registry is ACTIVE or INACTIVE. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "abc123", + "message": "abc123", + "privacy_settings": "PRIVATE", + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" +} +``` + + + +### UpdateGiftRegistryItemInput + +Defines updates to an item in a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_registry_item_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryItem` object. | +| `note` - [`String`](#string) | The updated description of the item. | +| `quantity` - [`Float!`](#float) | The updated quantity of the gift registry item. | + +#### Example + +```json +{ + "gift_registry_item_uid": "4", + "note": "xyz789", + "quantity": 987.65 +} +``` + + + +### UpdateGiftRegistryItemsOutput + +Contains the results of a request to update gift registry items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating updating items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryOutput + +Contains the results of a request to update a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The updated gift registry. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateGiftRegistryRegistrantInput + +Defines updates to an existing registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#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`](#string) | The updated email address of the registrant. | +| `firstname` - [`String`](#string) | The updated first name of the registrant. | +| `gift_registry_registrant_uid` - [`ID!`](#id) | The unique ID of a `giftRegistryRegistrant` object. | +| `lastname` - [`String`](#string) | The updated last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "abc123", + "gift_registry_registrant_uid": "4", + "lastname": "abc123" +} +``` + + + +### UpdateGiftRegistryRegistrantsOutput + +Contains the results a request to update registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after updating registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### UpdateNegotiableQuoteItemsQuantityOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### UpdateNegotiableQuoteQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteItemQuantityInput]!`](#negotiablequoteitemquantityinput) | An array of items to update. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteItemQuantityInput], + "quote_uid": "4" +} +``` + + + +### UpdateNegotiableQuoteTemplateItemsQuantityOutput + +Contains the updated negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote_template` - [`NegotiableQuoteTemplate`](#negotiablequotetemplate) | The updated negotiable quote template. | + +#### Example + +```json +{"quote_template": NegotiableQuoteTemplate} +``` + + + +### UpdateNegotiableQuoteTemplateQuantitiesInput + +Specifies the items to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `items` - [`[NegotiableQuoteTemplateItemQuantityInput]!`](#negotiablequotetemplateitemquantityinput) | An array of items to update. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "items": [NegotiableQuoteTemplateItemQuantityInput], + "template_id": 4 +} +``` + + + +### UpdateProductsInWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while updating products in a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully updated. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### UpdatePurchaseOrderApprovalRuleInput + +Defines the changes to be made to an approval rule. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]`](#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]`](#id) | An updated list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput`](#createpurchaseorderapprovalruleconditioninput) | The updated condition of the purchase order approval rule. | +| `description` - [`String`](#string) | The updated approval rule description. | +| `name` - [`String`](#string) | The updated approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus`](#purchaseorderapprovalrulestatus) | The updated status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | Unique identifier for the purchase order approval rule. | + +#### Example + +```json +{ + "applies_to": [4], + "approvers": [4], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, + "description": "abc123", + "name": "xyz789", + "status": "ENABLED", + "uid": "4" +} +``` + + + +### UpdateRequisitionListInput + +An input object that defines which requistion list characteristics to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | The updated description of the requisition list. | +| `name` - [`String!`](#string) | The new name of the requisition list. | + +#### Example + +```json +{ + "description": "xyz789", + "name": "xyz789" +} +``` + + + +### UpdateRequisitionListItemsInput + +Defines which items in a requisition list to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of customer-entered options. | +| `item_id` - [`ID!`](#id) | The ID of the requisition list item to update. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | +| `selected_options` - [`[String]`](#string) | An array of selected option IDs. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "item_id": "4", + "quantity": 123.45, + "selected_options": ["abc123"] +} +``` + + + +### UpdateRequisitionListItemsOutput + +Output of the request to update items in the specified requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after updating items. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateRequisitionListOutput + +Output of the request to rename the requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The renamed requisition list. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### UpdateWishlistOutput + +Contains the name and visibility of an updated wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](#string) | The wish list name. | +| `uid` - [`ID!`](#id) | The unique ID of a `Wishlist` object. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "name": "abc123", + "uid": 4, + "visibility": "PUBLIC" +} +``` + + + +### UrlRewrite + +Contains URL rewrite details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `parameters` - [`[HttpQueryParameter]`](#httpqueryparameter) | An array of request parameters. | +| `url` - [`String`](#string) | The request URL. | + +#### Example + +```json +{ + "parameters": [HttpQueryParameter], + "url": "abc123" +} +``` + + + +### UrlRewriteEntityTypeEnum + +This enumeration defines the entity type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CMS_PAGE` | | +| `PRODUCT` | | +| `CATEGORY` | | + +#### Example + +```json +""CMS_PAGE"" +``` + + + +### UseInLayeredNavigationOptions + +Defines whether the attribute is filterable in layered navigation. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NO` | | +| `FILTERABLE_WITH_RESULTS` | | +| `FILTERABLE_NO_RESULT` | | + +#### Example + +```json +""NO"" +``` + + + +### UserCompaniesInput + +Defines the input for returning matching companies the customer is assigned to. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `currentPage` - [`Int`](#int) | Specifies which page of results to return. The default value is 1. | +| `pageSize` - [`Int`](#int) | Specifies the maximum number of results to return at once. This attribute is optional. | +| `sort` - [`[CompaniesSortInput]`](#companiessortinput) | Defines the sorting of the results. | + +#### Example + +```json +{ + "currentPage": 987, + "pageSize": 987, + "sort": [CompaniesSortInput] +} +``` + + + +### UserCompaniesOutput + +An object that contains a list of companies customer is assigned to. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of companies customer is assigned to. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Provides navigation for the query response. | + +#### Example + +```json +{ + "items": [CompanyBasicInfo], + "page_info": SearchResultPageInfo +} +``` + + + +### ValidatePurchaseOrderError + +Contains details about a failed validation attempt. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`ValidatePurchaseOrderErrorType!`](#validatepurchaseordererrortype) | Error type. | + +#### Example + +```json +{"message": "abc123", "type": "NOT_FOUND"} +``` + + + +### ValidatePurchaseOrderErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | + +#### Example + +```json +""NOT_FOUND"" +``` + + + +### ValidatePurchaseOrdersInput + +Defines the purchase orders to be validated. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of the purchase order IDs. | + +#### Example + +```json +{"purchase_order_uids": [4]} +``` + + + +### ValidatePurchaseOrdersOutput + +Contains the results of validation attempts. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[ValidatePurchaseOrderError]!`](#validatepurchaseordererror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | An array of the purchase orders in the request. | + +#### Example + +```json +{ + "errors": [ValidatePurchaseOrderError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### ValidationRule + +Defines a customer attribute validation rule. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`ValidationRuleEnum`](#validationruleenum) | Validation rule name applied to a customer attribute. | +| `value` - [`String`](#string) | Validation rule value. | + +#### Example + +```json +{ + "name": "DATE_RANGE_MAX", + "value": "abc123" +} +``` + + + +### ValidationRuleEnum + +List of validation rule names applied to a customer attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""DATE_RANGE_MAX"" +``` + + + +### VaultConfigOutput + +Retrieves the vault configuration + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `credit_card` - [`VaultCreditCardConfig`](#vaultcreditcardconfig) | Credit card vault method configuration | + +#### Example + +```json +{"credit_card": VaultCreditCardConfig} +``` + + + +### VaultCreditCardConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_vault_enabled` - [`Boolean`](#boolean) | Is vault enabled | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The parameters required to load the Paypal JS SDK | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | + +#### Example + +```json +{ + "is_vault_enabled": true, + "sdk_params": [SDKParams], + "three_ds_mode": "OFF" +} +``` + + + +### VaultMethodInput + +Vault payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| `public_hash` - [`String`](#string) | The public hash of the token. | + +#### Example + +```json +{ + "payment_source": "abc123", + "payments_order_id": "xyz789", + "paypal_order_id": "abc123", + "public_hash": "abc123" +} +``` + + + +### VaultSetupTokenInput + +The payment source information + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`PaymentSourceInput!`](#paymentsourceinput) | The payment source information | + +#### Example + +```json +{"payment_source": PaymentSourceInput} +``` + + + +### VaultTokenInput + +Contains required input for payment methods with Vault support. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `public_hash` - [`String!`](#string) | The public hash of the payment token. | + +#### Example + +```json +{"public_hash": "abc123"} +``` + + + +### VirtualCartItem + +An implementation for virtual product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `id` - [`String!`](#string) | *(Deprecated: Use `uid` instead.)* | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "id": "xyz789", + "is_available": true, + "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 +} +``` + + + +### VirtualProduct + +Defines a virtual product, which is a non-tangible product that does not require shipping and is not kept in inventory. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_set_id` - [`Int`](#int) | The attribute set assigned to the product. *(Deprecated: The field should not be used on the storefront.)* | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `color` - [`Int`](#int) | *(Deprecated: Use the `custom_attributes` field instead.)* | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `created_at` - [`String`](#string) | Timestamp indicating when the product was created. *(Deprecated: The field should not be used on the storefront.)* | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | An array of cross-sell products. | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `id` - [`Int`](#int) | The ID number assigned to the product. *(Deprecated: Use the `uid` field instead.)* | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. *(Deprecated: Use the `custom_attributes` field instead.)* | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `media_gallery_entries` - [`[MediaGalleryEntry]`](#mediagalleryentry) | An array of MediaGalleryEntry objects. *(Deprecated: Use `media_gallery` instead.)* | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price` - [`ProductPrices`](#productprices) | Indicates the price of an item. *(Deprecated: Use `price_range` for product price information.)* | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Amount of available stock | +| `rating_summary` - [`Float!`](#float) | The average of all the ratings given to the product. | +| `redirect_code` - [`Int!`](#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]`](#productinterface) | An array of related products. | +| `relative_url` - [`String`](#string) | The internal relative URL. If the specified URL is a redirect, the query returns the redirected URL, not the original. | +| `review_count` - [`Int!`](#int) | The total count of all the reviews given to the product. | +| `reviews` - [`ProductReviews!`](#productreviews) | The list of products reviews. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_from_date` - [`String`](#string) | The beginning date that a product has a special price. *(Deprecated: The field should not be used on the storefront.)* | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `staged` - [`Boolean!`](#boolean) | Indicates whether the product is staged for a future campaign. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `tier_price` - [`Float`](#float) | The price when tier pricing is in effect and the items purchased threshold has been reached. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `tier_prices` - [`[ProductTierPrices]`](#producttierprices) | An array of ProductTierPrices objects. *(Deprecated: Use `price_tiers` for product tier price information.)* | +| `type` - [`UrlRewriteEntityTypeEnum`](#urlrewriteentitytypeenum) | One of PRODUCT, CATEGORY, or CMS_PAGE. | +| `type_id` - [`String`](#string) | One of simple, virtual, bundle, downloadable, grouped, or configurable. *(Deprecated: Use `__typename` instead.)* | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the product was updated. *(Deprecated: The field should not be used on the storefront.)* | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | An array of up-sell products. | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `url_path` - [`String`](#string) | *(Deprecated: Use product's `canonical_url` or url rewrites instead)* | +| `url_rewrites` - [`[UrlRewrite]`](#urlrewrite) | URL rewrites list | +| `url_suffix` - [`String`](#string) | The part of the product URL that is appended after the url key | +| `websites` - [`[Website]`](#website) | An array of websites in which the product is available. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "attribute_set_id": 123, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "color": 123, + "country_of_manufacture": "abc123", + "created_at": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": true, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "id": 123, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "media_gallery_entries": [MediaGalleryEntry], + "meta_description": "abc123", + "meta_keyword": "abc123", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price": ProductPrices, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "rating_summary": 987.65, + "redirect_code": 987, + "related_products": [ProductInterface], + "relative_url": "xyz789", + "review_count": 123, + "reviews": ProductReviews, + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_from_date": "xyz789", + "special_price": 123.45, + "special_to_date": "xyz789", + "staged": true, + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "tier_price": 123.45, + "tier_prices": [ProductTierPrices], + "type": "CMS_PAGE", + "type_id": "xyz789", + "uid": "4", + "updated_at": "xyz789", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "url_path": "xyz789", + "url_rewrites": [UrlRewrite], + "url_suffix": "abc123", + "websites": [Website] +} +``` + + + +### VirtualProductCartItemInput + +Defines a single product to add to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `data` - [`CartItemInput!`](#cartiteminput) | An object containing the `sku`, `quantity`, and other relevant information about the product. | + +#### Example + +```json +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput +} +``` + + + +### VirtualRequisitionListItem + +Contains details about virtual products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The amount added. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "uid": "4" +} +``` + + + +### VirtualWishlistItem + +Contains a virtual product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### Website + +Deprecated. It should not be used on the storefront. Contains information about a website. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | A code assigned to the website to identify it. *(Deprecated: The field should not be used on the storefront.)* | +| `default_group_id` - [`String`](#string) | The default group ID of the website. *(Deprecated: The field should not be used on the storefront.)* | +| `id` - [`Int`](#int) | The ID number assigned to the website. *(Deprecated: The field should not be used on the storefront.)* | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this is the default website. *(Deprecated: The field should not be used on the storefront.)* | +| `name` - [`String`](#string) | The website name. Websites use this name to identify it easier. *(Deprecated: The field should not be used on the storefront.)* | +| `sort_order` - [`Int`](#int) | The attribute to use for sorting websites. *(Deprecated: The field should not be used on the storefront.)* | + +#### Example + +```json +{ + "code": "abc123", + "default_group_id": "xyz789", + "id": 987, + "is_default": true, + "name": "xyz789", + "sort_order": 987 +} +``` + + + +### WishListUserInputError + +An error encountered while performing operations with WishList. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishListUserInputErrorType!`](#wishlistuserinputerrortype) | A wish list-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123" +} +``` + + + +### WishListUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### Wishlist + +Contains a customer wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The unique ID for a `Wishlist` object. | +| `items` - [`[WishlistItem]`](#wishlistitem) | *(Deprecated: Use the `items_v2` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. | +| `items_v2` - [`WishlistItems`](#wishlistitems) | An array of items in the customer's wish list. | +| `name` - [`String`](#string) | The name of the wish list. | +| `sharing_code` - [`String`](#string) | An encrypted code that Magento uses to link to the wish list. | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{ + "id": "4", + "items": [WishlistItem], + "items_count": 123, + "items_v2": WishlistItems, + "name": "xyz789", + "sharing_code": "xyz789", + "updated_at": "xyz789", + "visibility": "PUBLIC" +} +``` + + + +### WishlistCartUserInputError + +Contains details about errors encountered when a customer added wish list items to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`WishlistCartUserInputErrorType!`](#wishlistcartuserinputerrortype) | An error code that describes the error encountered. | +| `message` - [`String!`](#string) | A localized error message. | +| `wishlistId` - [`ID!`](#id) | The unique ID of the `Wishlist` object containing an error. | +| `wishlistItemId` - [`ID!`](#id) | The unique ID of the wish list item containing an error. | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123", + "wishlistId": 4, + "wishlistItemId": "4" +} +``` + + + +### WishlistCartUserInputErrorType + +A list of possible error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRODUCT_NOT_FOUND` | | +| `REQUIRED_PARAMETER_MISSING` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | + +#### Example + +```json +""PRODUCT_NOT_FOUND"" +``` + + + +### WishlistItem + +Contains details about a wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String`](#string) | The time when the customer added the item to the wish list. | +| `description` - [`String`](#string) | The customer's comment about this item. | +| `id` - [`Int`](#int) | The unique ID for a `WishlistItem` object. | +| `product` - [`ProductInterface`](#productinterface) | Details about the wish list item. | +| `qty` - [`Float`](#float) | The quantity of this wish list item | + +#### Example + +```json +{ + "added_at": "abc123", + "description": "abc123", + "id": 123, + "product": ProductInterface, + "qty": 123.45 +} +``` + + + +### WishlistItemCopyInput + +Specifies the IDs of items to copy and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be copied. | + +#### Example + +```json +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} +``` + + + +### WishlistItemInput + +Defines the items to add to a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `parent_sku` - [`String`](#string) | For complex product types, the SKU of the parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of items to add. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `sku` - [`String!`](#string) | The SKU of the product to add. For complex product types, specify the child product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": [4], + "sku": "xyz789" +} +``` + + + +### WishlistItemInterface + +The interface for wish list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface`](#productinterface) | Product details of the wish list item. | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Possible Types + +| WishlistItemInterface Types | +|----------------| +| [`SimpleWishlistItem`](#simplewishlistitem) | +| [`VirtualWishlistItem`](#virtualwishlistitem) | +| [`ConfigurableWishlistItem`](#configurablewishlistitem) | +| [`DownloadableWishlistItem`](#downloadablewishlistitem) | +| [`BundleWishlistItem`](#bundlewishlistitem) | +| [`GiftCardWishlistItem`](#giftcardwishlistitem) | +| [`GroupedProductWishlistItem`](#groupedproductwishlistitem) | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### WishlistItemMoveInput + +Specifies the IDs of the items to move and their quantities. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float`](#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!`](#id) | The unique ID of the `WishlistItemInterface` object to be moved. | + +#### Example + +```json +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} +``` + + + +### WishlistItemUpdateInput + +Defines updates to items in a wish list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | Customer-entered comments about the item. | +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of options that the customer entered. | +| `quantity` - [`Float`](#float) | The new amount or number of this item. | +| `selected_options` - [`[ID]`](#id) | An array of strings corresponding to options the customer selected. | +| `wishlist_item_id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | + +#### Example + +```json +{ + "description": "abc123", + "entered_options": [EnteredOptionInput], + "quantity": 123.45, + "selected_options": [4], + "wishlist_item_id": 4 +} +``` + + + +### WishlistItems + +Contains an array of items in a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItemInterface]!`](#wishlistiteminterface) | A list of items in the wish list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | + +#### Example + +```json +{ + "items": [WishlistItemInterface], + "page_info": SearchResultPageInfo +} +``` + + + +### WishlistOutput + +Deprecated: Use the `Wishlist` type instead. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[WishlistItem]`](#wishlistitem) | An array of items in the customer's wish list *(Deprecated: Use the `Wishlist.items` field instead.)* | +| `items_count` - [`Int`](#int) | The number of items in the wish list. *(Deprecated: Use the `Wishlist.items_count` field instead.)* | +| `name` - [`String`](#string) | When multiple wish lists are enabled, the name the customer assigns to the wishlist. *(Deprecated: This field is related to Commerce functionality and is always `null` in Open Source.)* | +| `sharing_code` - [`String`](#string) | An encrypted code that links to the wish list. *(Deprecated: Use the `Wishlist.sharing_code` field instead.)* | +| `updated_at` - [`String`](#string) | The time of the last modification to the wish list. *(Deprecated: Use the `Wishlist.updated_at` field instead.)* | + +#### Example + +```json +{ + "items": [WishlistItem], + "items_count": 123, + "name": "abc123", + "sharing_code": "xyz789", + "updated_at": "xyz789" +} +``` + + + +### WishlistVisibilityEnum + +Defines the wish list visibility types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PUBLIC` | | +| `PRIVATE` | | + +#### Example + +```json +""PUBLIC"" +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index 02175ef14..635d53ee6 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -115,11 +115,11 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "expiration_date": "xyz789", + "created_at": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, @@ -130,15 +130,15 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, - "total_quantity": 123.45, - "uid": 4, - "updated_at": "abc123" + "status": "abc123", + "template_id": "4", + "total_quantity": 987.65, + "uid": "4", + "updated_at": "xyz789" } } } @@ -286,7 +286,7 @@ mutation addProductsToCart( ```json { - "cartId": "abc123", + "cartId": "xyz789", "cartItems": [CartItemInput] } ``` @@ -447,7 +447,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -505,10 +505,7 @@ mutation addProductsToWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItems": [WishlistItemInput] -} +{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} ``` ##### Response @@ -663,8 +660,8 @@ mutation addRequisitionListItemsToCart( ```json { - "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListUid": 4, + "requisitionListItemUids": ["4"] } ``` @@ -816,10 +813,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemIds": ["4"] -} +{"wishlistId": 4, "wishlistItemIds": [4]} ``` ##### Response @@ -831,7 +825,7 @@ mutation addWishlistItemsToCart( "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } } @@ -989,7 +983,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -1176,7 +1170,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": false + "result": true } } } @@ -1280,19 +1274,19 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, + "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": 987.65 + "total_quantity": 123.45 } } } @@ -1377,8 +1371,8 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "abc123", + "created_at": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, @@ -1386,7 +1380,7 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1396,9 +1390,9 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, "updated_at": "abc123" } @@ -1450,7 +1444,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1644,8 +1638,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "xyz789", - "newPassword": "abc123" + "currentPassword": "abc123", + "newPassword": "xyz789" } ``` @@ -1663,22 +1657,22 @@ mutation changeCustomerPassword( "company_hierarchy": [CompanyHierarchy], "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", "email": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": "4", - "is_subscribed": false, + "is_subscribed": true, "job_title": "abc123", "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -1686,8 +1680,8 @@ mutation changeCustomerPassword( "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, - "quote_enabled": true, + "purchase_orders_enabled": false, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1697,8 +1691,8 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", - "taxvat": "abc123", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "abc123", "wishlist_v2": Wishlist, @@ -1740,7 +1734,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "xyz789"} +{"cartUid": "abc123"} ``` ##### Response @@ -1956,7 +1950,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -2089,7 +2083,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": false}}} +{"data": {"contactUs": {"status": true}}} ``` @@ -2134,7 +2128,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, + "sourceRequisitionListUid": "4", "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } @@ -2200,7 +2194,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", + "sourceWishlistUid": 4, "destinationWishlistUid": "4", "wishlistItems": [WishlistItemCopyInput] } @@ -2426,7 +2420,7 @@ mutation createCompareList($input: CreateCompareListInput) { "data": { "createCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": 4 } @@ -2502,11 +2496,11 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": false, + "default_billing": true, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", "id": 987, "lastname": "xyz789", "middlename": "abc123", @@ -2518,7 +2512,7 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "suffix": "xyz789", "telephone": "abc123", "uid": "4", - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -2690,11 +2684,11 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, - "currency_code": "xyz789", - "id": "xyz789", - "mp_order_id": "abc123", - "status": "abc123" + "amount": 987.65, + "currency_code": "abc123", + "id": "abc123", + "mp_order_id": "xyz789", + "status": "xyz789" } } } @@ -2758,7 +2752,7 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", "created_by": "abc123", - "description": "xyz789", + "description": "abc123", "name": "abc123", "status": "ENABLED", "uid": 4, @@ -2856,7 +2850,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } } } @@ -3019,7 +3013,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": false}}} +{"data": {"deleteCompanyTeam": {"success": true}}} ``` @@ -3051,13 +3045,13 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": false}}} +{"data": {"deleteCompanyUserV2": {"success": true}}} ``` @@ -3095,7 +3089,7 @@ mutation deleteCompareList($uid: ID!) { ##### Response ```json -{"data": {"deleteCompareList": {"result": true}}} +{"data": {"deleteCompareList": {"result": false}}} ``` @@ -3153,13 +3147,13 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 987} +{"id": 123} ``` ##### Response ```json -{"data": {"deleteCustomerAddress": false}} +{"data": {"deleteCustomerAddress": true}} ``` @@ -3189,13 +3183,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response ```json -{"data": {"deleteCustomerAddressV2": false}} +{"data": {"deleteCustomerAddressV2": true}} ``` @@ -3231,7 +3225,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": true}} +{"data": {"deleteNegotiableQuoteTemplate": false}} ``` @@ -3419,7 +3413,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": 4} +{"requisitionListUid": "4"} ``` ##### Response @@ -3474,7 +3468,7 @@ mutation deleteRequisitionListItems( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItemUids": ["4"] } ``` @@ -3642,10 +3636,10 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "additional_data": [ShippingAdditionalData], "amount": Money, "available": true, - "carrier_code": "xyz789", - "carrier_title": "xyz789", - "error_message": "xyz789", - "method_code": "abc123", + "carrier_code": "abc123", + "carrier_title": "abc123", + "error_message": "abc123", + "method_code": "xyz789", "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money @@ -3780,7 +3774,7 @@ mutation exchangeOtpForCustomerToken( ```json { - "email": "xyz789", + "email": "abc123", "otp": "xyz789" } ``` @@ -3791,7 +3785,7 @@ mutation exchangeOtpForCustomerToken( { "data": { "exchangeOtpForCustomerToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -3835,8 +3829,8 @@ mutation finishUpload($input: finishUploadInput!) { { "data": { "finishUpload": { - "key": "abc123", - "message": "xyz789", + "key": "xyz789", + "message": "abc123", "success": true } } @@ -3880,7 +3874,7 @@ mutation generateCustomerToken( ```json { - "email": "xyz789", + "email": "abc123", "password": "abc123" } ``` @@ -3935,7 +3929,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "xyz789" + "customer_token": "abc123" } } } @@ -4019,7 +4013,7 @@ mutation importSharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "xyz789"} +{"token": "abc123"} ``` ##### Response @@ -4201,7 +4195,7 @@ mutation mergeCarts( "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -4249,7 +4243,7 @@ mutation moveCartItemsToGiftRegistry( ##### Variables ```json -{"cartUid": 4, "giftRegistryUid": "4"} +{"cartUid": 4, "giftRegistryUid": 4} ``` ##### Response @@ -4311,8 +4305,8 @@ mutation moveItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": "4", + "sourceRequisitionListUid": 4, + "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4523,29 +4517,29 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, "total_quantity": 123.45, - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -4829,8 +4823,8 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "abc123", - "expiration_date": "abc123" + "code": "xyz789", + "expiration_date": "xyz789" } } } @@ -5035,7 +5029,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -5082,7 +5076,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{"giftRegistryUid": 4, "itemsUid": [4]} +{"giftRegistryUid": 4, "itemsUid": ["4"]} ``` ##### Response @@ -5315,16 +5309,16 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "abc123", + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -5392,7 +5386,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -5439,10 +5433,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemsIds": ["4"] -} +{"wishlistId": 4, "wishlistItemsIds": ["4"]} ``` ##### Response @@ -5529,7 +5520,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -5899,11 +5890,11 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, + "max_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -5915,10 +5906,10 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 987.65, - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -5951,7 +5942,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -6085,15 +6076,15 @@ mutation resetPassword( ```json { "email": "abc123", - "resetPasswordToken": "abc123", - "newPassword": "xyz789" + "resetPasswordToken": "xyz789", + "newPassword": "abc123" } ``` ##### Response ```json -{"data": {"resetPassword": false}} +{"data": {"resetPassword": true}} ``` @@ -6119,7 +6110,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": false}}} +{"data": {"revokeCustomerToken": {"result": true}}} ``` @@ -6238,7 +6229,7 @@ mutation setCartAsInactive($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response @@ -6994,10 +6985,10 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, @@ -7008,14 +6999,14 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, - "total_quantity": 123.45, - "uid": "4", + "template_id": "4", + "total_quantity": 987.65, + "uid": 4, "updated_at": "xyz789" } } @@ -7141,22 +7132,22 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "setQuoteTemplateExpirationDate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "abc123", + "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": 987, + "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], @@ -7250,14 +7241,14 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": false, + "is_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7270,9 +7261,9 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65, - "uid": "4", - "updated_at": "xyz789" + "total_quantity": 123.45, + "uid": 4, + "updated_at": "abc123" } } } @@ -7398,7 +7389,7 @@ mutation shareGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "sender": ShareGiftRegistrySenderInput, "invitees": [ShareGiftRegistryInviteeInput] } @@ -7487,7 +7478,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -7585,10 +7576,10 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": false, + "is_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -7596,14 +7587,14 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, - "total_quantity": 123.45, - "uid": 4, + "status": "abc123", + "template_id": "4", + "total_quantity": 987.65, + "uid": "4", "updated_at": "xyz789" } } @@ -7687,7 +7678,7 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "subscribeProductAlertPrice": { - "message": "abc123", + "message": "xyz789", "success": true } } @@ -7733,8 +7724,8 @@ mutation subscribeProductAlertStock($input: ProductAlertStockInput!) { { "data": { "subscribeProductAlertStock": { - "message": "xyz789", - "success": false + "message": "abc123", + "success": true } } } @@ -7773,7 +7764,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": false}} +{"data": {"syncPaymentOrder": true}} ``` @@ -7862,7 +7853,7 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { "data": { "unsubscribeProductAlertPrice": { "message": "abc123", - "success": true + "success": false } } } @@ -7941,8 +7932,8 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { { "data": { "unsubscribeProductAlertStock": { - "message": "xyz789", - "success": true + "message": "abc123", + "success": false } } } @@ -7975,7 +7966,7 @@ mutation unsubscribeProductAlertStockAll { { "data": { "unsubscribeProductAlertStockAll": { - "message": "xyz789", + "message": "abc123", "success": false } } @@ -8307,24 +8298,24 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, - "default_shipping": true, + "default_billing": false, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": 987, - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", + "id": 123, + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "abc123", "uid": 4, "vat_id": "abc123" @@ -8395,10 +8386,7 @@ mutation updateCustomerAddressV2( ##### Variables ```json -{ - "uid": "4", - "input": CustomerAddressInput -} +{"uid": 4, "input": CustomerAddressInput} ``` ##### Response @@ -8417,17 +8405,17 @@ mutation updateCustomerAddressV2( "fax": "xyz789", "firstname": "abc123", "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", + "lastname": "abc123", + "middlename": "abc123", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["abc123"], "suffix": "abc123", "telephone": "abc123", - "uid": "4", - "vat_id": "xyz789" + "uid": 4, + "vat_id": "abc123" } } } @@ -8472,8 +8460,8 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", - "password": "xyz789" + "email": "xyz789", + "password": "abc123" } ``` @@ -8562,7 +8550,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "giftRegistry": UpdateGiftRegistryInput } ``` @@ -8672,7 +8660,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -8898,8 +8886,8 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "xyz789", - "created_by": "xyz789", - "description": "xyz789", + "created_by": "abc123", + "description": "abc123", "name": "xyz789", "status": "ENABLED", "uid": 4, @@ -9065,8 +9053,8 @@ mutation updateWishlist( ```json { - "wishlistId": "4", - "name": "xyz789", + "wishlistId": 4, + "name": "abc123", "visibility": "PUBLIC" } ``` @@ -9077,7 +9065,7 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "xyz789", + "name": "abc123", "uid": 4, "visibility": "PUBLIC" } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-queries.md b/src/pages/includes/autogenerated/graphql-api-saas-queries.md index 80523427d..45a77ab46 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -350,154 +350,154 @@ query availableStores($useCurrentGroup: Boolean) { "data": { "availableStores": [ { - "allow_company_registration": true, - "allow_gift_receipt": "abc123", + "allow_company_registration": false, + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_items": "abc123", - "allow_order": "abc123", - "allow_printed_card": "abc123", + "allow_items": "xyz789", + "allow_order": "xyz789", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "abc123", - "base_media_url": "xyz789", + "base_currency_code": "abc123", + "base_link_url": "xyz789", + "base_media_url": "abc123", "base_static_url": "xyz789", - "base_url": "abc123", + "base_url": "xyz789", "cart_expires_in_days": 987, - "cart_gift_wrapping": "xyz789", + "cart_gift_wrapping": "abc123", "cart_merge_preference": "xyz789", "cart_printed_card": "xyz789", "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": "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_max_order_total": "abc123", - "check_money_order_min_order_total": "abc123", - "check_money_order_new_order_status": "abc123", + "check_money_order_enabled": true, + "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": "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", - "company_credit_enabled": true, - "company_enabled": true, + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 987, + "check_money_order_title": "abc123", + "company_credit_enabled": false, + "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, - "countries_with_required_region": "xyz789", + "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": "xyz789", + "default_display_currency_code": "abc123", "display_product_prices_in_catalog": 123, "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_apply_tax_to_fpt": false, + "fixed_product_taxes_display_prices_in_emails": 123, "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_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, - "grid_per_page": 123, + "fixed_product_taxes_include_fpt_in_subtotal": true, + "graphql_share_customer_group": true, + "grid_per_page": 987, "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": false, - "is_default_store": true, + "is_checkout_agreements_enabled": true, + "is_default_store": false, "is_default_store_group": true, - "is_guest_checkout_enabled": false, + "is_guest_checkout_enabled": true, "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": false, - "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", + "locale": "xyz789", "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": "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": "abc123", - "magento_reward_points_order": "abc123", + "magento_reward_points_order": "xyz789", "magento_reward_points_register": "abc123", - "magento_reward_points_review": "abc123", - "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", + "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, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, "minicart_max_items": 123, "minimum_password_length": "xyz789", - "newsletter_enabled": true, + "newsletter_enabled": false, "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "order_cancellation_enabled": false, "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": 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": "xyz789", + "product_url_suffix": "abc123", "quickorder_active": true, - "quote_minimum_amount": 123.45, + "quote_minimum_amount": 987.65, "quote_minimum_amount_message": "xyz789", - "required_character_classes_number": "abc123", + "required_character_classes_number": "xyz789", "requisition_list_share_link_validity_days": 123, "requisition_list_share_max_recipients": 987, - "requisition_list_share_storefront_path": "abc123", + "requisition_list_share_storefront_path": "xyz789", "requisition_list_sharing_enabled": true, "returns_enabled": "abc123", - "root_category_uid": 4, + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", + "sales_gift_wrapping": "abc123", "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", - "secure_base_media_url": "xyz789", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "abc123", "secure_base_static_url": "abc123", - "secure_base_url": "abc123", - "share_active_segments": true, - "share_applied_cart_rule": false, - "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "xyz789", + "secure_base_url": "xyz789", + "share_active_segments": false, + "share_applied_cart_rule": true, + "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_tooltip": "abc123", "shopping_assistance_enabled": false, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": 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": 123, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": false, - "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": "abc123", "title_separator": "xyz789", - "use_store_in_url": true, + "use_store_in_url": false, "website_code": 4, - "website_name": "xyz789", + "website_name": "abc123", "weight_unit": "xyz789", - "zero_subtotal_enable_for_specific_countries": true, - "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_enable_for_specific_countries": false, + "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_title": "xyz789" + "zero_subtotal_title": "abc123" } ] } @@ -583,7 +583,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -606,8 +606,8 @@ query cart($cart_id: String!) { "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, - "is_virtual": true, + "id": "4", + "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, @@ -678,7 +678,7 @@ query categories( ```json { "ids": ["xyz789"], - "roles": ["abc123"], + "roles": ["xyz789"], "subtree": Subtree } ``` @@ -691,16 +691,16 @@ query categories( "categories": [ { "availableSortBy": ["xyz789"], - "children": ["abc123"], - "defaultSortBy": "abc123", + "children": ["xyz789"], + "defaultSortBy": "xyz789", "id": 4, "level": 987, - "name": "xyz789", - "parentId": "abc123", - "position": 987, - "path": "xyz789", - "roles": ["xyz789"], - "urlKey": "xyz789", + "name": "abc123", + "parentId": "xyz789", + "position": 123, + "path": "abc123", + "roles": ["abc123"], + "urlKey": "abc123", "urlPath": "abc123", "count": 987, "title": "abc123" @@ -744,8 +744,8 @@ query checkoutAgreements { "checkoutAgreements": [ { "agreement_id": 987, - "checkbox_text": "xyz789", - "content": "abc123", + "checkbox_text": "abc123", + "content": "xyz789", "content_height": "abc123", "is_html": false, "mode": "AUTO", @@ -779,13 +779,7 @@ query commerceOptimizer { ##### Response ```json -{ - "data": { - "commerceOptimizer": { - "priceBookId": "4" - } - } -} +{"data": {"commerceOptimizer": {"priceBookId": 4}}} ``` @@ -881,9 +875,9 @@ query company { "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", - "name": "xyz789", - "payment_methods": ["xyz789"], - "reseller_id": "xyz789", + "name": "abc123", + "payment_methods": ["abc123"], + "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -944,9 +938,9 @@ query compareList($uid: ID!) { "data": { "compareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -988,10 +982,10 @@ query countries { { "available_regions": [Region], "full_name_english": "xyz789", - "full_name_locale": "xyz789", - "id": "abc123", + "full_name_locale": "abc123", + "id": "xyz789", "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "two_letter_abbreviation": "xyz789" } ] } @@ -1034,7 +1028,7 @@ query country($id: String) { ##### Variables ```json -{"id": "abc123"} +{"id": "xyz789"} ``` ##### Response @@ -1044,11 +1038,11 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "abc123", - "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "xyz789" + "full_name_english": "xyz789", + "full_name_locale": "xyz789", + "id": "xyz789", + "three_letter_abbreviation": "abc123", + "two_letter_abbreviation": "abc123" } } } @@ -1088,12 +1082,12 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_currency_symbol": "abc123", "default_display_currency_code": "abc123", - "default_display_currency_symbol": "abc123", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } } @@ -1278,35 +1272,35 @@ query customer { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "abc123", - "default_shipping": "xyz789", - "email": "xyz789", + "default_shipping": "abc123", + "email": "abc123", "firstname": "xyz789", - "gender": 123, + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": "4", "is_subscribed": true, - "job_title": "abc123", - "lastname": "xyz789", + "job_title": "xyz789", + "lastname": "abc123", "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, @@ -1316,9 +1310,9 @@ query customer { "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "xyz789", - "taxvat": "abc123", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist_v2": Wishlist, @@ -1416,17 +1410,17 @@ query customerCart { "custom_attributes": [CustomAttribute], "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1489,7 +1483,7 @@ query customerGroup { ##### Response ```json -{"data": {"customerGroup": {"uid": "4"}}} +{"data": {"customerGroup": {"uid": 4}}} ``` @@ -1559,11 +1553,7 @@ query customerSegments($cartId: String!) { ##### Response ```json -{ - "data": { - "customerSegments": [{"uid": "4"}] - } -} +{"data": {"customerSegments": [{"uid": 4}]}} ``` @@ -1670,8 +1660,8 @@ query getPaymentOrder( ```json { - "cartId": "xyz789", - "id": "abc123" + "cartId": "abc123", + "id": "xyz789" } ``` @@ -1681,10 +1671,10 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "abc123", + "id": "xyz789", "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "status": "abc123" } } } @@ -1811,8 +1801,8 @@ query giftCardAccount($input: GiftCardAccountInput!) { "data": { "giftCardAccount": { "balance": Money, - "code": "abc123", - "expiration_date": "abc123" + "code": "xyz789", + "expiration_date": "xyz789" } } } @@ -1868,7 +1858,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -1881,10 +1871,10 @@ query giftRegistry($giftRegistryUid: ID!) { "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "xyz789", - "owner_name": "abc123", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -1930,7 +1920,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -1941,11 +1931,11 @@ query giftRegistryEmailSearch($email: String!) { "giftRegistryEmailSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": "4", - "location": "abc123", - "name": "abc123", - "type": "abc123" + "location": "xyz789", + "name": "xyz789", + "type": "xyz789" } ] } @@ -1997,11 +1987,11 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "abc123", - "gift_registry_uid": 4, - "location": "abc123", + "event_title": "xyz789", + "gift_registry_uid": "4", + "location": "xyz789", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ] } @@ -2053,7 +2043,7 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", + "firstName": "xyz789", "lastName": "xyz789", "giftRegistryTypeUid": "4" } @@ -2066,10 +2056,10 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "xyz789", "gift_registry_uid": 4, - "location": "xyz789", + "location": "abc123", "name": "xyz789", "type": "abc123" } @@ -2113,7 +2103,7 @@ query giftRegistryTypes { GiftRegistryDynamicAttributeMetadataInterface ], "label": "xyz789", - "uid": "4" + "uid": 4 } ] } @@ -2225,7 +2215,7 @@ query guestOrder($input: GuestOrderInformationInput!) { { "data": { "guestOrder": { - "admin_assisted_order": 123, + "admin_assisted_order": 987, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], @@ -2235,9 +2225,9 @@ query guestOrder($input: GuestOrderInformationInput!) { "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "id": 4, "invoices": [Invoice], @@ -2255,7 +2245,7 @@ query guestOrder($input: GuestOrderInformationInput!) { "shipping_address": OrderAddress, "shipping_method": "abc123", "status": "xyz789", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -2372,7 +2362,7 @@ query guestOrderByToken($input: OrderTokenInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], @@ -2381,21 +2371,21 @@ query guestOrderByToken($input: OrderTokenInput!) { "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "abc123", - "order_date": "xyz789", - "order_status_change_date": "abc123", + "number": "xyz789", + "order_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "abc123", "token": "abc123", "total": OrderTotal @@ -2471,13 +2461,13 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} ``` @@ -2509,13 +2499,13 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} ``` @@ -2547,7 +2537,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2679,8 +2669,8 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { { "data": { "isSubscribedProductAlertStock": { - "isSubscribed": true, - "message": "xyz789" + "isSubscribed": false, + "message": "abc123" } } } @@ -2776,12 +2766,12 @@ query negotiableQuote($uid: ID!) { "comments": [NegotiableQuoteComment], "created_at": "xyz789", "custom_attributes": [CustomAttribute], - "email": "abc123", - "expiration_date": "abc123", + "email": "xyz789", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "is_virtual": false, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "order": CustomerOrder, "prices": CartPrices, "sales_rep_name": "xyz789", @@ -2794,7 +2784,7 @@ query negotiableQuote($uid: ID!) { "template_name": "xyz789", "total_quantity": 987.65, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -2879,16 +2869,16 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -2898,10 +2888,10 @@ query negotiableQuoteTemplate($templateId: ID!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", "total_quantity": 987.65, - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -3050,7 +3040,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } } } @@ -3128,7 +3118,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -3201,7 +3191,7 @@ query productSearch( "current_page": 1, "filter": [SearchClauseInput], "page_size": 20, - "phrase": "xyz789", + "phrase": "abc123", "sort": [ProductSearchSortInput] } ``` @@ -3215,9 +3205,9 @@ query productSearch( "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["abc123"], - "suggestions": ["abc123"], - "total_count": 987, + "related_terms": ["xyz789"], + "suggestions": ["xyz789"], + "total_count": 123, "warnings": [ProductSearchWarning] } } @@ -3294,27 +3284,27 @@ query products($skus: [String]) { "data": { "products": [ { - "addToCartAllowed": false, - "inStock": true, - "lowStock": true, + "addToCartAllowed": true, + "inStock": false, + "lowStock": false, "attributes": [ProductViewAttribute], "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "xyz789", - "metaTitle": "abc123", + "metaDescription": "xyz789", + "metaKeyword": "abc123", + "metaTitle": "xyz789", "name": "abc123", - "shortDescription": "xyz789", + "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], "sku": "xyz789", "externalId": "xyz789", "url": "xyz789", "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "abc123", + "queryType": "xyz789", "visibility": "abc123" } ] @@ -3456,11 +3446,11 @@ query recaptchaV3Config { "badge_position": "abc123", "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "abc123", + "is_enabled": true, + "language_code": "xyz789", "minimum_score": 123.45, "theme": "xyz789", - "website_key": "xyz789" + "website_key": "abc123" } } } @@ -3524,9 +3514,9 @@ query recommendations( ```json { - "cartSkus": ["xyz789"], + "cartSkus": ["abc123"], "category": "xyz789", - "currentSku": "abc123", + "currentSku": "xyz789", "currentProduct": CurrentProductInput, "pageType": "CMS", "userPurchaseHistory": [PurchaseHistory], @@ -3627,28 +3617,28 @@ query refineProduct( { "data": { "refineProduct": { - "addToCartAllowed": true, + "addToCartAllowed": false, "inStock": true, "lowStock": false, "attributes": [ProductViewAttribute], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", "metaKeyword": "xyz789", "metaTitle": "xyz789", - "name": "xyz789", + "name": "abc123", "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], "sku": "xyz789", - "externalId": "abc123", + "externalId": "xyz789", "url": "xyz789", - "urlKey": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "xyz789", - "visibility": "xyz789" + "queryType": "abc123", + "visibility": "abc123" } } } @@ -3881,148 +3871,148 @@ query storeConfig { "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "xyz789", - "allow_items": "abc123", + "allow_items": "xyz789", "allow_order": "xyz789", "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "xyz789", - "base_static_url": "abc123", + "base_link_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "xyz789", "base_url": "xyz789", "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", + "cart_gift_wrapping": "xyz789", "cart_merge_preference": "abc123", - "cart_printed_card": "abc123", - "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "abc123", + "cart_printed_card": "xyz789", + "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_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": "xyz789", + "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": "xyz789", "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 987, - "check_money_order_title": "xyz789", + "check_money_order_sort_order": 123, + "check_money_order_title": "abc123", "company_credit_enabled": false, "company_enabled": true, "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", + "configurable_thumbnail_source": "abc123", "contact_enabled": true, "countries_with_required_region": "abc123", - "create_account_confirmation": false, + "create_account_confirmation": true, "customer_access_token_lifetime": 123.45, - "default_country": "abc123", + "default_country": "xyz789", "default_display_currency_code": "xyz789", - "display_product_prices_in_catalog": 123, + "display_product_prices_in_catalog": 987, "display_shipping_prices": 987, "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", + "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_emails": 123, + "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": true, + "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": false, "graphql_share_customer_group": false, - "grid_per_page": 987, - "grid_per_page_values": "abc123", + "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": false, - "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": true, + "is_negotiable_quote_active": true, + "is_one_page_checkout_enabled": false, "is_requisition_list_active": "abc123", "list_mode": "abc123", - "list_per_page": 123, + "list_per_page": 987, "list_per_page_values": "xyz789", "locale": "abc123", - "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "abc123", + "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": "xyz789", - "magento_reward_points_invitation_customer_limit": "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": "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_order": "xyz789", + "magento_reward_points_register": "abc123", "magento_reward_points_review": "abc123", - "magento_reward_points_review_limit": "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": false, + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": true, "minicart_max_items": 123, "minimum_password_length": "xyz789", "newsletter_enabled": false, - "optional_zip_countries": "xyz789", + "optional_zip_countries": "abc123", "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_price": 987, - "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", + "product_url_suffix": "xyz789", "quickorder_active": false, "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "abc123", - "required_character_classes_number": "abc123", + "required_character_classes_number": "xyz789", "requisition_list_share_link_validity_days": 123, "requisition_list_share_max_recipients": 123, - "requisition_list_share_storefront_path": "abc123", + "requisition_list_share_storefront_path": "xyz789", "requisition_list_sharing_enabled": false, "returns_enabled": "abc123", - "root_category_uid": 4, + "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": "abc123", + "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", - "share_active_segments": false, + "secure_base_url": "abc123", + "share_active_segments": true, "share_applied_cart_rule": false, - "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "xyz789", - "shopping_assistance_enabled": true, + "shopping_assistance_enabled": false, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": true, + "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": false, "store_code": 4, - "store_group_code": 4, + "store_group_code": "4", "store_group_name": "abc123", - "store_name": "xyz789", + "store_name": "abc123", "store_sort_order": 987, "timezone": "xyz789", - "title_separator": "abc123", + "title_separator": "xyz789", "use_store_in_url": true, - "website_code": 4, + "website_code": "4", "website_name": "xyz789", "weight_unit": "xyz789", - "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, + "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "abc123" + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "xyz789" } } } @@ -4072,9 +4062,9 @@ query variants( ```json { - "sku": "abc123", + "sku": "xyz789", "optionIds": ["xyz789"], - "pageSize": 123, + "pageSize": 987, "cursor": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-2.md b/src/pages/includes/autogenerated/graphql-api-saas-types-2.md deleted file mode 100644 index e3327ef70..000000000 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-2.md +++ /dev/null @@ -1,6511 +0,0 @@ -### Customer - -Defines the customer name, addresses, and other details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | -| `admin_assistance_actions` - [`AdminAssistanceActions!`](#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | -| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | -| `company_hierarchy` - [`[CompanyHierarchy]`](#companyhierarchy) | The company relation hierarchies for all companies. Only available to the company administrator. | -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | -| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | -| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | -| `email` - [`String`](#string) | The customer's email address. Required. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | -| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | -| `group` - [`CustomerGroupStorefront`](#customergroupstorefront) | Customer group assigned to the customer | -| `id` - [`ID!`](#id) | The unique ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `orders` - [`CustomerOrders`](#customerorders) | | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | -| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | -| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | -| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | -| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | -| `purchase_orders_enabled` - [`Boolean!`](#boolean) | Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result. | -| `quote_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | -| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | -| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | -| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | -| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | -| `segments` - [`[CustomerSegmentStorefront]`](#customersegmentstorefront) | Customer segments associated with the current customer | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | -| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | -| `telephone` - [`String`](#string) | The phone number of the company user. | -| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | -| `wishlists` - [`[Wishlist]!`](#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. | - -#### Example - -```json -{ - "addresses": [CustomerAddress], - "addressesV2": CustomerAddresses, - "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, - "companies": UserCompaniesOutput, - "company_hierarchy": [CompanyHierarchy], - "compare_list": CompareList, - "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "abc123", - "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "abc123", - "default_shipping": "abc123", - "email": "xyz789", - "firstname": "xyz789", - "gender": 987, - "gift_registries": [GiftRegistry], - "gift_registry": GiftRegistry, - "group": CustomerGroupStorefront, - "id": 4, - "is_subscribed": false, - "job_title": "xyz789", - "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, - "quote_enabled": false, - "requisition_lists": RequisitionLists, - "return": Return, - "returns": Returns, - "reward_points": RewardPoints, - "role": CompanyRole, - "segments": [CustomerSegmentStorefront], - "status": "ACTIVE", - "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "abc123", - "taxvat": "abc123", - "team": CompanyTeam, - "telephone": "abc123", - "wishlist_v2": Wishlist, - "wishlists": [Wishlist] -} -``` - - - -### CustomerAddress - -Contains detailed information about a customer's billing or shipping address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | -| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | -| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | -| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `uid` - [`ID`](#id) | The unique ID for a `CustomerAddress` object. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, - "default_shipping": true, - "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "xyz789", - "id": 987, - "lastname": "abc123", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", - "region": CustomerAddressRegion, - "region_id": 987, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "uid": 4, - "vat_id": "abc123" -} -``` - - - -### CustomerAddressAttribute - -Specifies the attribute code and value of a customer address attribute. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | -| `value` - [`String`](#string) | The value assigned to the customer address attribute. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "xyz789" -} -``` - - - -### CustomerAddressInput - -Contains details about a billing or shipping address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The customer's city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | -| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | -| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | -| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "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": "abc123", - "telephone": "xyz789", - "vat_id": "abc123" -} -``` - - - -### CustomerAddressRegion - -Defines the customer's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "xyz789", - "region_code": "abc123", - "region_id": 987 -} -``` - - - -### CustomerAddressRegionInput - -Defines the customer's state or province. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `region` - [`String`](#string) | The state or province name. | -| `region_code` - [`String`](#string) | The address region code. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "region": "xyz789", - "region_code": "xyz789", - "region_id": 987 -} -``` - - - -### CustomerAddresses - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer addresses. | - -#### Example - -```json -{ - "items": [CustomerAddress], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerAttributeMetadata - -Customer attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | - -#### Example - -```json -{ - "code": "4", - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": true, - "is_unique": false, - "label": "abc123", - "multiline_count": 987, - "options": [CustomAttributeOptionInterface], - "sort_order": 987, - "validate_rules": [ValidationRule] -} -``` - - - -### CustomerCreateInput - -An input object for creating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `email` - [`String!`](#string) | The customer's email address. | -| `firstname` - [`String!`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String!`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `password` - [`String`](#string) | The customer's password. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", - "email": "abc123", - "firstname": "xyz789", - "gender": 123, - "is_subscribed": false, - "lastname": "xyz789", - "middlename": "xyz789", - "password": "abc123", - "prefix": "xyz789", - "suffix": "abc123", - "taxvat": "abc123" -} -``` - - - -### CustomerDownloadableProduct - -Contains details about a single downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date` - [`String`](#string) | The date and time the purchase was made. | -| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | -| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | -| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | -| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | - -#### Example - -```json -{ - "date": "abc123", - "download_url": "abc123", - "order_increment_id": "abc123", - "remaining_downloads": "xyz789", - "status": "xyz789" -} -``` - - - -### CustomerDownloadableProducts - -Contains a list of downloadable products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | - -#### Example - -```json -{"items": [CustomerDownloadableProduct]} -``` - - - -### CustomerGroupStorefront - -Data of customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerGroup` object. | - -#### Example - -```json -{"uid": 4} -``` - - - -### CustomerOrder - -Contains details about each of the customer's orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `admin_assisted_order` - [`Int`](#int) | Admin user id when the order was placed with assistance (Login as Customer); null if not assisted. | -| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | -| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | -| `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | -| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | -| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | -| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order | -| `customer_info` - [`OrderCustomerInfo!`](#ordercustomerinfo) | Returns customer information from order. | -| `email` - [`String`](#string) | Order customer email. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | -| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | -| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | -| `is_virtual` - [`Boolean!`](#boolean) | `TRUE` if the order is virtual | -| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | -| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | -| `negotiable_quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote associated with this order. | -| `number` - [`String!`](#string) | The order number. | -| `order_date` - [`String!`](#string) | The date the order was placed. | -| `order_status_change_date` - [`String!`](#string) | The date the order status was last updated. | -| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | -| `returns` - [`Returns`](#returns) | Return requests associated with this order. | -| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | -| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | -| `shipping_method` - [`String`](#string) | The delivery method for the order. | -| `status` - [`String!`](#string) | The current status of the order. | -| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | -| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | - -#### Example - -```json -{ - "admin_assisted_order": 987, - "applied_coupons": [AppliedCoupon], - "applied_gift_cards": [ApplyGiftCardToOrder], - "available_actions": ["REORDER"], - "billing_address": OrderAddress, - "carrier": "abc123", - "comments": [SalesCommentItem], - "credit_memos": [CreditMemo], - "custom_attributes": [CustomAttribute], - "customer_info": OrderCustomerInfo, - "email": "abc123", - "gift_message": GiftMessage, - "gift_receipt_included": false, - "gift_wrapping": GiftWrapping, - "id": "4", - "invoices": [Invoice], - "is_virtual": true, - "items": [OrderItemInterface], - "items_eligible_for_return": [OrderItemInterface], - "negotiable_quote": NegotiableQuote, - "number": "abc123", - "order_date": "xyz789", - "order_status_change_date": "xyz789", - "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, - "returns": Returns, - "shipments": [OrderShipment], - "shipping_address": OrderAddress, - "shipping_method": "abc123", - "status": "xyz789", - "token": "xyz789", - "total": OrderTotal -} -``` - - - -### CustomerOrderSortInput - -CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | -| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "NUMBER"} -``` - - - -### CustomerOrderSortableField - -Specifies the field to use for sorting - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NUMBER` | Sorts customer orders by number | -| `CREATED_AT` | Sorts customer orders by created_at field | - -#### Example - -```json -""NUMBER"" -``` - - - -### CustomerOrders - -The collection of orders that match the conditions defined in the filter. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | -| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int`](#int) | The total count of customer orders. | - -#### Example - -```json -{ - "date_of_first_order": "abc123", - "items": [CustomerOrder], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### CustomerOrdersFilterInput - -Identifies the filter to use for filtering orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `grand_total` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order base grand total value. | -| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | -| `order_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order created_at time. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filters by order status. | - -#### Example - -```json -{ - "grand_total": FilterRangeTypeInput, - "number": FilterStringTypeInput, - "order_date": FilterRangeTypeInput, - "status": FilterEqualTypeInput -} -``` - - - -### CustomerOutput - -Contains details about a newly-created or updated customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | - -#### Example - -```json -{"customer": Customer} -``` - - - -### CustomerPaymentTokens - -Contains payment tokens stored in the customer's vault. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | - -#### Example - -```json -{"items": [PaymentToken]} -``` - - - -### CustomerSegmentStorefront - -Customer segment details - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomerSegment` object. | - -#### Example - -```json -{"uid": 4} -``` - - - -### CustomerStoreCredit - -Contains store credit information with balance and history. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance_history` - [`CustomerStoreCreditHistory`](#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. | -| `current_balance` - [`Money`](#money) | The current balance of store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | - -#### Example - -```json -{ - "balance_history": CustomerStoreCreditHistory, - "current_balance": Money, - "enabled": true -} -``` - - - -### CustomerStoreCreditHistory - -Lists changes to the amount of store credit available to the customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of items returned. | - -#### Example - -```json -{ - "items": [CustomerStoreCreditHistoryItem], - "page_info": SearchResultPageInfo, - "total_count": 987 -} -``` - - - -### CustomerStoreCreditHistoryItem - -Contains store credit history information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `action` - [`String`](#string) | The action that was made on the store credit. | -| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | -| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | -| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | - -#### Example - -```json -{ - "action": "abc123", - "actual_balance": Money, - "balance_change": Money, - "date_time_changed": "xyz789" -} -``` - - - -### CustomerToken - -Contains a customer authorization token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `token` - [`String`](#string) | The customer authorization token. | - -#### Example - -```json -{"token": "xyz789"} -``` - - - -### CustomerUpdateInput - -An input object for updating a customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | -| `date_of_birth` - [`String`](#string) | The customer's date of birth. | -| `firstname` - [`String`](#string) | The customer's first name. | -| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | -| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | -| `lastname` - [`String`](#string) | The customer's family name. | -| `middlename` - [`String`](#string) | The customer's middle name. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "allow_remote_shopping_assistance": false, - "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", - "firstname": "xyz789", - "gender": 123, - "is_subscribed": true, - "lastname": "xyz789", - "middlename": "xyz789", - "prefix": "xyz789", - "suffix": "xyz789", - "taxvat": "abc123" -} -``` - - - -### CustomizableAreaOption - -Contains information about a text area that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | - -#### Example - -```json -{ - "product_sku": "xyz789", - "required": false, - "sort_order": 123, - "title": "abc123", - "uid": "4", - "value": CustomizableAreaValue -} -``` - - - -### CustomizableAreaValue - -Defines the price and sku of a product whose page contains a customized text area. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | - -#### Example - -```json -{ - "max_characters": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableCheckboxOption - -Contains information about a set of checkbox values that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | - -#### Example - -```json -{ - "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": [CustomizableCheckboxValue] -} -``` - - - -### CustomizableCheckboxValue - -Defines the price and sku of a product whose page contains a customized set of checkbox values. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "abc123", - "uid": 4 -} -``` - - - -### CustomizableDateOption - -Contains information about a date picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | - -#### Example - -```json -{ - "product_sku": "xyz789", - "required": true, - "sort_order": 123, - "title": "xyz789", - "uid": "4", - "value": CustomizableDateValue -} -``` - - - -### CustomizableDateTypeEnum - -Defines the customizable date type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `DATE` | | -| `DATE_TIME` | | -| `TIME` | | - -#### Example - -```json -""DATE"" -``` - - - -### CustomizableDateValue - -Defines the price and sku of a product whose page contains a customized date picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | - -#### Example - -```json -{ - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "type": "DATE", - "uid": "4" -} -``` - - - -### CustomizableDropDownOption - -Contains information about a drop down menu that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | - -#### Example - -```json -{ - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": 4, - "value": [CustomizableDropDownValue] -} -``` - - - -### CustomizableDropDownValue - -Defines the price and sku of a product whose page contains a customized drop down menu. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 123, - "title": "abc123", - "uid": 4 -} -``` - - - -### CustomizableFieldOption - -Contains information about a text field that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | - -#### Example - -```json -{ - "product_sku": "xyz789", - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": "4", - "value": CustomizableFieldValue -} -``` - - - -### CustomizableFieldValue - -Defines the price and sku of a product whose page contains a customized text field. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | -| `price` - [`Float`](#float) | The price of the custom value. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | - -#### Example - -```json -{ - "max_characters": 123, - "price": 987.65, - "price_type": "FIXED", - "sku": "xyz789", - "uid": "4" -} -``` - - - -### CustomizableFileOption - -Contains information about a file picker that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | - -#### Example - -```json -{ - "product_sku": "xyz789", - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": CustomizableFileValue -} -``` - - - -### CustomizableFileValue - -Defines the price and sku of a product whose page contains a customized file picker. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `file_extension` - [`String`](#string) | The file extension to accept. | -| `image_size_x` - [`Int`](#int) | The maximum width of an image. | -| `image_size_y` - [`Int`](#int) | The maximum height of an image. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | - -#### Example - -```json -{ - "file_extension": "abc123", - "image_size_x": 987, - "image_size_y": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 -} -``` - - - -### CustomizableMultipleOption - -Contains information about a multiselect that is defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | - -#### Example - -```json -{ - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": 4, - "value": [CustomizableMultipleValue] -} -``` - - - -### CustomizableMultipleValue - -Defines the price and sku of a product whose page contains a customized multiselect. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | - -#### Example - -```json -{ - "option_type_id": 987, - "price": 123.45, - "price_type": "FIXED", - "sku": "xyz789", - "sort_order": 987, - "title": "abc123", - "uid": 4 -} -``` - - - -### CustomizableOptionInput - -Defines a customizable option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `value_string` - [`String!`](#string) | The string value of the option. | - -#### Example - -```json -{ - "uid": "4", - "value_string": "abc123" -} -``` - - - -### CustomizableOptionInterface - -Contains basic information about a customizable option. It can be implemented by several types of configurable options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | - -#### Possible Types - -| CustomizableOptionInterface Types | -|----------------| -| [`CustomizableAreaOption`](#customizableareaoption) | -| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | -| [`CustomizableDateOption`](#customizabledateoption) | -| [`CustomizableDropDownOption`](#customizabledropdownoption) | -| [`CustomizableFieldOption`](#customizablefieldoption) | -| [`CustomizableFileOption`](#customizablefileoption) | -| [`CustomizableMultipleOption`](#customizablemultipleoption) | -| [`CustomizableRadioOption`](#customizableradiooption) | - -#### Example - -```json -{ - "required": true, - "sort_order": 123, - "title": "abc123", - "uid": "4" -} -``` - - - -### CustomizableProductInterface - -Contains information about customizable product options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | - -#### Possible Types - -| CustomizableProductInterface Types | -|----------------| -| [`BundleProduct`](#bundleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`VirtualProduct`](#virtualproduct) | - -#### Example - -```json -{"options": [CustomizableOptionInterface]} -``` - - - -### CustomizableRadioOption - -Contains information about a set of radio buttons that are defined as part of a customizable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | -| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | -| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | - -#### Example - -```json -{ - "required": false, - "sort_order": 987, - "title": "abc123", - "uid": "4", - "value": [CustomizableRadioValue] -} -``` - - - -### CustomizableRadioValue - -Defines the price and sku of a product whose page contains a customized set of radio buttons. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | -| `price` - [`Float`](#float) | The price assigned to this option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | -| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | -| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | -| `title` - [`String`](#string) | The display name for this option. | -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | - -#### Example - -```json -{ - "option_type_id": 123, - "price": 123.45, - "price_type": "FIXED", - "sku": "abc123", - "sort_order": 987, - "title": "abc123", - "uid": 4 -} -``` - - - -### DateTime - -A slightly refined version of RFC-3339 compliant DateTime Scalar - -#### Example - -```json -"2007-12-03T10:15:30Z" -``` - - - -### DeleteCompanyRoleOutput - -Contains the response to the request to delete the company role. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | - -#### Example - -```json -{"success": false} -``` - - - -### DeleteCompanyTeamOutput - -Contains the status of the request to delete a company team. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | - -#### Example - -```json -{"success": true} -``` - - - -### DeleteCompanyUserOutput - -Contains the response to the request to delete the company user. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | - -#### Example - -```json -{"success": false} -``` - - - -### DeleteCompareListOutput - -Contains the results of the request to delete a compare list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | - -#### Example - -```json -{"result": true} -``` - - - -### DeleteNegotiableQuoteError - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | - -#### Example - -```json -NegotiableQuoteInvalidStateError -``` - - - -### DeleteNegotiableQuoteOperationFailure - -Contains details about a failed delete operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 -} -``` - - - -### DeleteNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | - -#### Example - -```json -NegotiableQuoteUidOperationSuccess -``` - - - -### DeleteNegotiableQuoteTemplateInput - -Specifies the quote template id of the quote template to delete - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": 4} -``` - - - -### DeleteNegotiableQuotesInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | - -#### Example - -```json -{"quote_uids": [4]} -``` - - - -### DeleteNegotiableQuotesOutput - -Contains a list of undeleted negotiable quotes the company user can view. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | -| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | - -#### Example - -```json -{ - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} -``` - - - -### DeletePaymentTokenOutput - -Indicates whether the request succeeded and returns the remaining customer payment tokens. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | - -#### Example - -```json -{ - "customerPaymentTokens": CustomerPaymentTokens, - "result": false -} -``` - - - -### DeletePurchaseOrderApprovalRuleError - -Contains details about an error that occurred when deleting an approval rule . - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The text of the error message. | -| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | - -#### Example - -```json -{"message": "abc123", "type": "UNDEFINED"} -``` - - - -### DeletePurchaseOrderApprovalRuleErrorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNDEFINED` | | -| `NOT_FOUND` | | - -#### Example - -```json -""UNDEFINED"" -``` - - - -### DeletePurchaseOrderApprovalRuleInput - -Specifies the IDs of the approval rules to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | - -#### Example - -```json -{"approval_rule_uids": [4]} -``` - - - -### DeletePurchaseOrderApprovalRuleOutput - -Contains any errors encountered while attempting to delete approval rules. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | - -#### Example - -```json -{"errors": [DeletePurchaseOrderApprovalRuleError]} -``` - - - -### DeleteRequisitionListItemsOutput - -Output of the request to remove items from the requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | - -#### Example - -```json -{"requisition_list": RequisitionList} -``` - - - -### DeleteRequisitionListOutput - -Indicates whether the request to delete the requisition list was successful. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | - -#### Example - -```json -{"requisition_lists": RequisitionLists, "status": false} -``` - - - -### DeleteWishlistOutput - -Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | -| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | - -#### Example - -```json -{"status": true, "wishlists": [Wishlist]} -``` - - - -### Discount - -Specifies the discount type and value for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | -| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | -| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | -| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | -| `label` - [`String!`](#string) | A description of the discount. | -| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | -| `value` - [`Float`](#float) | Quote line item discount value. | - -#### Example - -```json -{ - "amount": Money, - "applied_to": "ITEM", - "coupon": AppliedCoupon, - "is_discounting_locked": true, - "label": "xyz789", - "type": "abc123", - "value": 123.45 -} -``` - - - -### DownloadableCartItem - -An implementation for downloadable product cart items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | -| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "backorder_message": "xyz789", - "custom_attributes": [CustomAttribute], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "is_available": true, - "is_salable": false, - "links": [DownloadableProductLinks], - "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": 123.45, - "samples": [DownloadableProductSamples], - "uid": 4 -} -``` - - - -### DownloadableCreditMemoItem - -Defines downloadable product options for `CreditMemoItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 987.65 -} -``` - - - -### DownloadableInvoiceItem - -Defines downloadable product options for `InvoiceItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "downloadable_links": [DownloadableItemsLinks], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 -} -``` - - - -### DownloadableItemsLinks - -Defines characteristics of the links for downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | - -#### Example - -```json -{ - "sort_order": 987, - "title": "abc123", - "uid": "4" -} -``` - - - -### DownloadableOrderItem - -Defines downloadable product options for `OrderItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "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": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "abc123" -} -``` - - - -### DownloadableProduct - -Defines a product that the shopper downloads. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | -| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | -| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | - -#### Example - -```json -{ - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "country_of_manufacture": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "downloadable_product_links": [ - DownloadableProductLinks - ], - "downloadable_product_samples": [ - DownloadableProductSamples - ], - "gift_message_available": false, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "image": ProductImage, - "is_returnable": "abc123", - "links_purchased_separately": 123, - "links_title": "xyz789", - "manufacturer": 123, - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "related_products": [ProductInterface], - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "uid": 4, - "upsell_products": [ProductInterface], - "url_key": "xyz789" -} -``` - - - -### DownloadableProductCartItemInput - -Defines a single downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | -| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | -| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | - -#### Example - -```json -{ - "customizable_options": [CustomizableOptionInput], - "data": CartItemInput, - "downloadable_product_links": [ - DownloadableProductLinksInput - ] -} -``` - - - -### DownloadableProductLinks - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `price` - [`Float`](#float) | The price of the downloadable product. | -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the link. | -| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | - -#### Example - -```json -{ - "price": 987.65, - "sample_url": "xyz789", - "sort_order": 123, - "title": "xyz789", - "uid": "4" -} -``` - - - -### DownloadableProductLinksInput - -Contains the link ID for the downloadable product. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | - -#### Example - -```json -{"link_id": 987} -``` - - - -### DownloadableProductSamples - -Defines characteristics of a downloadable product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | -| `sort_order` - [`Int`](#int) | A number indicating the sort order. | -| `title` - [`String`](#string) | The display name of the sample. | - -#### Example - -```json -{ - "sample_url": "abc123", - "sort_order": 123, - "title": "abc123" -} -``` - - - -### DownloadableRequisitionListItem - -Contains details about downloadable products added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | -| `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "links": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 987.65, - "samples": [DownloadableProductSamples], - "sku": "abc123", - "uid": 4 -} -``` - - - -### DownloadableWishlistItem - -A downloadable product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | -| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | -| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "links_v2": [DownloadableProductLinks], - "product": ProductInterface, - "quantity": 987.65, - "samples": [DownloadableProductSamples] -} -``` - - - -### DuplicateNegotiableQuoteInput - -Identifies a quote to be duplicated - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | -| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | - -#### Example - -```json -{"duplicated_quote_uid": 4, "quote_uid": 4} -``` - - - -### DuplicateNegotiableQuoteOutput - -Contains the newly created negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### EnteredCustomAttributeInput - -Contains details about a custom text attribute that the buyer entered. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | -| `value` - [`String!`](#string) | The text or other entered value. | - -#### Example - -```json -{ - "attribute_code": "xyz789", - "value": "abc123" -} -``` - - - -### EnteredOptionInput - -Defines a customer-entered option. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `value` - [`String!`](#string) | Text the customer entered. | - -#### Example - -```json -{"uid": 4, "value": "xyz789"} -``` - - - -### Error - -An error encountered while adding an item to the the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | - -#### Possible Types - -| Error Types | -|----------------| -| [`CartUserInputError`](#cartuserinputerror) | -| [`InsufficientStockError`](#insufficientstockerror) | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "abc123" -} -``` - - - -### ErrorInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Possible Types - -| ErrorInterface Types | -|----------------| -| [`InternalError`](#internalerror) | -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### EstimateAddressInput - -Contains details about an address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | - -#### Example - -```json -{ - "country_code": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput -} -``` - - - -### EstimateTotalsInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | -| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | -| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | - -#### Example - -```json -{ - "address": EstimateAddressInput, - "cart_id": "xyz789", - "shipping_method": ShippingMethodInput -} -``` - - - -### EstimateTotalsOutput - -Estimate totals output. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | Cart after totals estimation | - -#### Example - -```json -{"cart": Cart} -``` - - - -### ExchangeExternalCustomerTokenInput - -Contains details about external customer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer characteristics to update. | - -#### Example - -```json -{"customer": CustomerCreateInput} -``` - - - -### ExchangeExternalCustomerTokenOutput - -Contains customer token for external customer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | -| `token` - [`String!`](#string) | The customer authorization token. | - -#### Example - -```json -{ - "customer": Customer, - "token": "abc123" -} -``` - - - -### ExchangeRate - -Lists the exchange rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | -| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | - -#### Example - -```json -{"currency_to": "abc123", "rate": 987.65} -``` - - - -### FastlaneConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "code": "abc123", - "is_visible": true, - "payment_intent": "xyz789", - "payment_source": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds_mode": "OFF", - "title": "xyz789" -} -``` - - - -### FastlaneMethodInput - -Fastlane Payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `paypal_fastlane_token` - [`String`](#string) | The single use token from Fastlane | - -#### Example - -```json -{ - "payment_source": "xyz789", - "paypal_fastlane_token": "xyz789" -} -``` - - - -### Field - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNKNOWN_FIELD` | | -| `CATEGORY` | | -| `PRICE` | | -| `PRODUCT` | | -| `OUT_OF_STOCK` | | -| `LOW_STOCK` | | -| `TYPE` | | -| `VISIBILITY` | | - -#### Example - -```json -""UNKNOWN_FIELD"" -``` - - - -### FilterEqualTypeInput - -Defines a filter that matches the input exactly. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#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]`](#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 - -```json -{ - "eq": "abc123", - "in": ["abc123"] -} -``` - - - -### FilterMatchTypeEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `FULL` | | -| `PARTIAL` | | - -#### Example - -```json -""FULL"" -``` - - - -### FilterMatchTypeInput - -Defines a filter that performs a fuzzy search. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `match` - [`String`](#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`](#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 - -```json -{"match": "abc123", "match_type": "FULL"} -``` - - - -### FilterRangeTypeInput - -Defines a filter that matches a range of values, such as prices or dates. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | -| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | - -#### Example - -```json -{ - "from": "xyz789", - "to": "abc123" -} -``` - - - -### FilterRuleInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`String`](#string) | | -| `type` - [`FilterRuleType`](#filterruletype) | | -| `conditions` - [`[ConditionInput]`](#conditioninput) | | - -#### Example - -```json -{ - "name": "xyz789", - "type": "UNKNOWN_FILTER_RULE_TYPE", - "conditions": [ConditionInput] -} -``` - - - -### FilterRuleType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNKNOWN_FILTER_RULE_TYPE` | | -| `INCLUSION` | | -| `EXCLUSION` | | - -#### Example - -```json -""UNKNOWN_FILTER_RULE_TYPE"" -``` - - - -### FilterStringTypeInput - -Defines a filter for an input string. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | -| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | -| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | - -#### Example - -```json -{ - "eq": "xyz789", - "in": ["xyz789"], - "match": "xyz789" -} -``` - - - -### FilterTypeInput - -Defines the comparison operators that can be used in a filter. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `eq` - [`String`](#string) | Equals. | -| `from` - [`String`](#string) | From. Must be used with the `to` field. | -| `gt` - [`String`](#string) | Greater than. | -| `gteq` - [`String`](#string) | Greater than or equal to. | -| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | -| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | -| `lt` - [`String`](#string) | Less than. | -| `lteq` - [`String`](#string) | Less than or equal to. | -| `moreq` - [`String`](#string) | More than or equal to. | -| `neq` - [`String`](#string) | Not equal to. | -| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | -| `notnull` - [`String`](#string) | Not null. | -| `null` - [`String`](#string) | Is null. | -| `to` - [`String`](#string) | To. Must be used with the `from` field. | - -#### Example - -```json -{ - "eq": "xyz789", - "from": "xyz789", - "gt": "abc123", - "gteq": "abc123", - "in": ["xyz789"], - "like": "xyz789", - "lt": "xyz789", - "lteq": "abc123", - "moreq": "xyz789", - "neq": "abc123", - "nin": ["abc123"], - "notnull": "xyz789", - "null": "abc123", - "to": "abc123" -} -``` - - - -### FilterableInSearchAttribute - -Contains product attributes that can be used for filtering in a `productSearch` query - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`String!`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without spaces | -| `frontendInput` - [`String`](#string) | Indicates how field rendered on storefront | -| `label` - [`String`](#string) | The display name assigned to the attribute | -| `numeric` - [`Boolean`](#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | - -#### Example - -```json -{ - "attribute": "abc123", - "frontendInput": "xyz789", - "label": "abc123", - "numeric": false -} -``` - - - -### FixedProductTax - -A single FPT that can be applied to a product price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | -| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | - -#### Example - -```json -{ - "amount": Money, - "label": "abc123" -} -``` - - - -### FixedProductTaxDisplaySettings - -Lists display settings for the Fixed Product Tax. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""INCLUDE_FPT_WITHOUT_DETAILS"" -``` - - - -### Float - -The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). - -#### Example - -```json -123.45 -``` - - - -### GenerateCustomerTokenAsAdminInput - -Identifies which customer requires remote shopping assistance. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | - -#### Example - -```json -{"customer_email": "abc123"} -``` - - - -### GenerateCustomerTokenAsAdminOutput - -Contains the generated customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customer_token` - [`String!`](#string) | The generated customer token. | - -#### Example - -```json -{"customer_token": "abc123"} -``` - - - -### GenerateNegotiableQuoteFromTemplateInput - -Specifies the template id, from which to generate quote from. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"template_id": "4"} -``` - - - -### GenerateNegotiableQuoteFromTemplateOutput - -Contains the generated negotiable quote id. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | - -#### Example - -```json -{"negotiable_quote_uid": 4} -``` - - - -### GetPaymentSDKOutput - -Gets the payment SDK URLs and values - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | - -#### Example - -```json -{"sdkParams": [PaymentSDKParamsItem]} -``` - - - -### GiftCardAccount - -Contains details about the gift card account. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`Money`](#money) | The balance remaining on the gift card. | -| `code` - [`String`](#string) | The gift card account code. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | - -#### Example - -```json -{ - "balance": Money, - "code": "abc123", - "expiration_date": "abc123" -} -``` - - - -### GiftCardAccountInput - -Contains the gift card code. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `gift_card_code` - [`String!`](#string) | The applied gift card code. | - -#### Example - -```json -{"gift_card_code": "xyz789"} -``` - - - -### GiftCardAmounts - -Contains the value of a gift card, the website that generated the card, and related information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_id` - [`Int`](#int) | An internal attribute ID. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | -| `value` - [`Float`](#float) | The value of the gift card. | -| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | -| `website_value` - [`Float`](#float) | The value of the gift card. | - -#### Example - -```json -{ - "attribute_id": 987, - "uid": "4", - "value": 987.65, - "website_id": 123, - "website_value": 123.45 -} -``` - - - -### GiftCardCartItem - -Contains details about a gift card that has been added to a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | -| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender. | -| `sender_name` - [`String!`](#string) | The name of the sender. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "amount": Money, - "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", - "custom_attributes": [CustomAttribute], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "is_available": false, - "is_salable": false, - "max_qty": 987.65, - "message": "abc123", - "min_qty": 987.65, - "not_available_message": "abc123", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "xyz789", - "sender_name": "abc123", - "uid": "4" -} -``` - - - -### GiftCardCreditMemoItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 -} -``` - - - -### GiftCardInvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### GiftCardItem - -Contains details about a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String`](#string) | The message from the sender to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | -| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | -| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | -| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | - -#### Example - -```json -{ - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "xyz789" -} -``` - - - -### GiftCardOptions - -Contains details about the sender, recipient, and amount of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `amount` - [`Money`](#money) | The amount and currency of the gift card. | -| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | -| `message` - [`String`](#string) | A message to the recipient. | -| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | -| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | -| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | -| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | - -#### Example - -```json -{ - "amount": Money, - "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", - "recipient_name": "xyz789", - "sender_email": "xyz789", - "sender_name": "abc123" -} -``` - - - -### GiftCardOrderItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "eligible_for_return": false, - "entered_options": [OrderItemOption], - "gift_card": GiftCardItem, - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "id": "4", - "prices": OrderItemPrices, - "product": ProductInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} -``` - - - -### GiftCardProduct - -Defines properties of a gift card. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | -| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | -| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | -| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "allow_message": true, - "allow_open_amount": false, - "canonical_url": "abc123", - "categories": [CategoryInterface], - "country_of_manufacture": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": false, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "giftcard_amounts": [GiftCardAmounts], - "giftcard_type": "VIRTUAL", - "image": ProductImage, - "is_redeemable": true, - "is_returnable": "abc123", - "lifetime": 987, - "manufacturer": 123, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "message_max_length": 987, - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 123.45, - "name": "xyz789", - "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": "xyz789", - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "related_products": [ProductInterface], - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "uid": 4, - "upsell_products": [ProductInterface], - "url_key": "abc123", - "weight": 987.65 -} -``` - - - -### GiftCardRequisitionListItem - -Contains details about gift cards added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The amount added. | -| `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "gift_card_options": GiftCardOptions, - "product": ProductInterface, - "quantity": 987.65, - "sku": "abc123", - "uid": "4" -} -``` - - - -### GiftCardShipmentItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Example - -```json -{ - "gift_card": GiftCardItem, - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 -} -``` - - - -### GiftCardTypeEnum - -Specifies the gift card type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `VIRTUAL` | | -| `PHYSICAL` | | -| `COMBINED` | | - -#### Example - -```json -""VIRTUAL"" -``` - - - -### GiftCardWishlistItem - -A single gift card added to a wish list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "gift_card_options": GiftCardOptions, - "id": 4, - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### GiftMessage - -Contains the text of a gift message, its sender, and recipient - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `from` - [`String!`](#string) | Sender name | -| `message` - [`String!`](#string) | Gift message text | -| `to` - [`String!`](#string) | Recipient name | - -#### Example - -```json -{ - "from": "xyz789", - "message": "abc123", - "to": "xyz789" -} -``` - - - -### GiftMessageInput - -Defines a gift message. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`String!`](#string) | The name of the sender. | -| `message` - [`String!`](#string) | The text of the gift message. | -| `to` - [`String!`](#string) | The name of the recepient. | - -#### Example - -```json -{ - "from": "abc123", - "message": "abc123", - "to": "abc123" -} -``` - - - -### GiftOptionsPrices - -Contains prices for gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | -| `gift_wrapping_for_items_incl_tax` - [`Money`](#money) | Price of the gift wrapping for all individual order items including tax. | -| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | -| `gift_wrapping_for_order_incl_tax` - [`Money`](#money) | Price of the gift wrapping for the whole order including tax. | -| `printed_card` - [`Money`](#money) | Price for the printed card. | -| `printed_card_incl_tax` - [`Money`](#money) | Price for the printed card including tax. | - -#### Example - -```json -{ - "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 -} -``` - - - -### GiftRegistry - -Contains details about a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | -| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | -| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | -| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | -| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | -| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | -| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | - -#### Example - -```json -{ - "created_at": "abc123", - "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 -} -``` - - - -### GiftRegistryDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": 4, - "group": "EVENT_INFORMATION", - "label": "xyz789", - "value": "abc123" -} -``` - - - -### GiftRegistryDynamicAttributeGroup - -Defines the group type of a gift registry dynamic attribute. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `EVENT_INFORMATION` | | -| `PRIVACY_SETTINGS` | | -| `REGISTRANT` | | -| `GENERAL_INFORMATION` | | -| `DETAILED_INFORMATION` | | -| `SHIPPING_ADDRESS` | | - -#### Example - -```json -""EVENT_INFORMATION"" -``` - - - -### GiftRegistryDynamicAttributeInput - -Defines a dynamic attribute. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | -| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | - -#### Example - -```json -{ - "code": "4", - "value": "xyz789" -} -``` - - - -### GiftRegistryDynamicAttributeInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Possible Types - -| GiftRegistryDynamicAttributeInterface Types | -|----------------| -| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | -| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | - -#### Example - -```json -{ - "code": "4", - "label": "xyz789", - "value": "xyz789" -} -``` - - - -### GiftRegistryDynamicAttributeMetadata - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Example - -```json -{ - "attribute_group": "abc123", - "code": 4, - "input_type": "xyz789", - "is_required": false, - "label": "xyz789", - "sort_order": 987 -} -``` - - - -### GiftRegistryDynamicAttributeMetadataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | - -#### Possible Types - -| GiftRegistryDynamicAttributeMetadataInterface Types | -|----------------| -| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | - -#### Example - -```json -{ - "attribute_group": "abc123", - "code": "4", - "input_type": "abc123", - "is_required": true, - "label": "xyz789", - "sort_order": 123 -} -``` - - - -### GiftRegistryItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface!`](#productinterface) | Details about the gift registry item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "abc123", - "product": ProductInterface, - "quantity": 987.65, - "quantity_fulfilled": 123.45, - "uid": "4" -} -``` - - - -### GiftRegistryItemInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | -| `note` - [`String`](#string) | A brief message about the gift registry item. | -| `product` - [`ProductInterface!`](#productinterface) | Details about the gift registry item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The requested quantity of the product. | -| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | -| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | - -#### Possible Types - -| GiftRegistryItemInterface Types | -|----------------| -| [`GiftRegistryItem`](#giftregistryitem) | - -#### Example - -```json -{ - "created_at": "xyz789", - "note": "xyz789", - "product": ProductInterface, - "quantity": 123.45, - "quantity_fulfilled": 123.45, - "uid": 4 -} -``` - - - -### GiftRegistryItemUserErrorInterface - -Contains the status and any errors that encountered with the customer's gift register item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Possible Types - -| GiftRegistryItemUserErrorInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{ - "status": true, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### GiftRegistryItemsUserError - -Contains details about an error that occurred when processing a gift registry item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | -| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | -| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | -| `message` - [`String!`](#string) | A localized error message. | -| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | - -#### Example - -```json -{ - "code": "OUT_OF_STOCK", - "gift_registry_item_uid": 4, - "gift_registry_uid": 4, - "message": "abc123", - "product_uid": 4 -} -``` - - - -### GiftRegistryItemsUserErrorType - -Defines the error type. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""OUT_OF_STOCK"" -``` - - - -### GiftRegistryOutputInterface - -Contains the customer's gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | - -#### Possible Types - -| GiftRegistryOutputInterface Types | -|----------------| -| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### GiftRegistryPrivacySettings - -Defines the privacy setting of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PRIVATE` | | -| `PUBLIC` | | - -#### Example - -```json -""PRIVATE"" -``` - - - -### GiftRegistryRegistrant - -Contains details about a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | -| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | - -#### Example - -```json -{ - "dynamic_attributes": [ - GiftRegistryRegistrantDynamicAttribute - ], - "email": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "uid": "4" -} -``` - - - -### GiftRegistryRegistrantDynamicAttribute - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | -| `label` - [`String!`](#string) | The display name of the dynamic attribute. | -| `value` - [`String!`](#string) | A corresponding value for the code. | - -#### Example - -```json -{ - "code": 4, - "label": "abc123", - "value": "abc123" -} -``` - - - -### GiftRegistrySearchResult - -Contains the results of a gift registry search. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `event_date` - [`String`](#string) | The date of the event. | -| `event_title` - [`String!`](#string) | The title given to the event. | -| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | -| `location` - [`String`](#string) | The location of the event. | -| `name` - [`String!`](#string) | The name of the gift registry owner. | -| `type` - [`String`](#string) | The type of event being held. | - -#### Example - -```json -{ - "event_date": "abc123", - "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "abc123", - "name": "abc123", - "type": "xyz789" -} -``` - - - -### GiftRegistryShippingAddressInput - -Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | -| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID assigned to this customer address. | - -#### Example - -```json -{ - "address_data": CustomerAddressInput, - "address_id": 4, - "customer_address_uid": "4" -} -``` - - - -### GiftRegistryStatus - -Defines the status of the gift registry. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `ACTIVE` | | -| `INACTIVE` | | - -#### Example - -```json -""ACTIVE"" -``` - - - -### GiftRegistryType - -Contains details about a gift registry type. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | -| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | - -#### Example - -```json -{ - "dynamic_attributes_metadata": [ - GiftRegistryDynamicAttributeMetadataInterface - ], - "label": "abc123", - "uid": 4 -} -``` - - - -### GiftWrapping - -Contains details about the selected or available gift wrapping options. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `design` - [`String!`](#string) | The name of the gift wrapping design. | -| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | -| `price` - [`Money!`](#money) | The gift wrapping price. | -| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | - -#### Example - -```json -{ - "design": "abc123", - "image": GiftWrappingImage, - "price": Money, - "uid": 4 -} -``` - - - -### GiftWrappingImage - -Points to an image associated with a gift wrapping option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The gift wrapping preview image label. | -| `url` - [`String!`](#string) | The gift wrapping preview image URL. | - -#### Example - -```json -{ - "label": "xyz789", - "url": "xyz789" -} -``` - - - -### GooglePayButtonStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `type` - [`String`](#string) | The button type | - -#### Example - -```json -{ - "color": "xyz789", - "height": 123, - "type": "abc123" -} -``` - - - -### GooglePayConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "button_styles": GooglePayButtonStyles, - "code": "xyz789", - "is_visible": true, - "payment_intent": "xyz789", - "payment_source": "abc123", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "three_ds_mode": "OFF", - "title": "abc123" -} -``` - - - -### GooglePayMethodInput - -Google Pay inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" -} -``` - - - -### GroupedProduct - -Defines a grouped product, which consists of simple standalone products that are presented as a group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Example - -```json -{ - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "image": ProductImage, - "is_returnable": "xyz789", - "items": [GroupedProductItem], - "manufacturer": 123, - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options_container": "abc123", - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "related_products": [ProductInterface], - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "uid": "4", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "weight": 123.45 -} -``` - - - -### GroupedProductItem - -Contains information about an individual grouped product item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | -| `product` - [`ProductInterface!`](#productinterface) | Details about this product option. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `qty` - [`Float`](#float) | The quantity of this grouped product item. | - -#### Example - -```json -{ - "position": 987, - "product": ProductInterface, - "qty": 987.65 -} -``` - - - -### GroupedProductWishlistItem - -A grouped product wish list item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "xyz789", - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": 4, - "product": ProductInterface, - "quantity": 123.45 -} -``` - - - -### GuestOrderCancelInput - -Input to retrieve a guest order based on token. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `reason` - [`String!`](#string) | Cancellation reason. | -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{ - "reason": "xyz789", - "token": "xyz789" -} -``` - - - -### GuestOrderInformationInput - -Input to retrieve an order based on details. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | Order billing address email. | -| `lastname` - [`String!`](#string) | Order billing address lastname. | -| `number` - [`String!`](#string) | Order number. | - -#### Example - -```json -{ - "email": "xyz789", - "lastname": "xyz789", - "number": "xyz789" -} -``` - - - -### Highlight - -An object that provides highlighted text for matched words - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attribute` - [`String!`](#string) | The product attribute that contains a match for the search phrase | -| `matched_words` - [`[String]!`](#string) | An array of strings | -| `value` - [`String!`](#string) | The matched text, enclosed within emphasis tags | - -#### Example - -```json -{ - "attribute": "xyz789", - "matched_words": ["abc123"], - "value": "xyz789" -} -``` - - - -### HistoryItemNoteData - -Item note data that is added to the negotiable quote history object. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String!`](#string) | Datetime of the note added. | -| `creator_name` - [`String!`](#string) | Name of the creator. | -| `creator_type` - [`String!`](#string) | Creator type: Buyer or Seller. | -| `item_id` - [`Int!`](#int) | Id of the quote item for which the note has been added. | -| `note` - [`String!`](#string) | The note added by the creator for the item | -| `product_name` - [`String!`](#string) | Name of the quote item product for which note has been added. | - -#### Example - -```json -{ - "created_at": "xyz789", - "creator_name": "xyz789", - "creator_type": "abc123", - "item_id": 123, - "note": "abc123", - "product_name": "abc123" -} -``` - - - -### HostedFieldsConfig - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cc_vault_code` - [`String`](#string) | Vault payment method code | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Example - -```json -{ - "cc_vault_code": "abc123", - "code": "xyz789", - "is_vault_enabled": false, - "is_visible": false, - "payment_intent": "xyz789", - "payment_source": "abc123", - "requires_card_details": true, - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "three_ds_mode": "OFF", - "title": "xyz789" -} -``` - - - -### HostedFieldsInput - -Hosted Fields payment inputs - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cardBin` - [`String`](#string) | Card bin number | -| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | -| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | -| `cardLast4` - [`String`](#string) | Last four digits of the card | -| `holderName` - [`String`](#string) | Name on the card | -| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cardBin": "xyz789", - "cardExpiryMonth": "abc123", - "cardExpiryYear": "xyz789", - "cardLast4": "abc123", - "holderName": "xyz789", - "is_active_payment_token_enabler": false, - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "xyz789" -} -``` - - - -### ID - -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 - -```json -"4" -``` - - - -### ImageSwatchData - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Example - -```json -{ - "thumbnail": "xyz789", - "value": "xyz789" -} -``` - - - -### ImportSharedRequisitionListOutput - -Result of importing a shared requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The imported requisition list for the current customer. | -| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Validation or import issues. | - -#### Example - -```json -{ - "requisition_list": RequisitionList, - "user_errors": [ShareRequisitionListUserError] -} -``` - - - -### InputFilterEnum - -List of templates/filters applied to customer attribute input. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""NONE"" -``` - - - -### InsufficientStockError - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | -| `quantity` - [`Float`](#float) | Amount of available stock | - -#### Example - -```json -{ - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", - "quantity": 987.65 -} -``` - - - -### Int - -The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. - -#### Example - -```json -123 -``` - - - -### InternalError - -Contains an error message when an internal error occurred. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### Invoice - -Contains invoice details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice | -| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | -| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | -| `number` - [`String!`](#string) | Sequential invoice number. | -| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | - -#### Example - -```json -{ - "comments": [SalesCommentItem], - "custom_attributes": [CustomAttribute], - "id": "4", - "items": [InvoiceItemInterface], - "number": "abc123", - "total": InvoiceTotal -} -``` - - - -### InvoiceCustomAttributesInput - -Defines an invoice custom attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for invoice. | -| `invoice_id` - [`String!`](#string) | The invoice ID. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttributeInput], - "invoice_id": "xyz789" -} -``` - - - -### InvoiceItem - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 -} -``` - - - -### InvoiceItemCustomAttributesInput - -Defines an invoice item custom attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for invoice item. | -| `invoice_id` - [`String!`](#string) | The invoice ID. | -| `invoice_item_id` - [`String!`](#string) | The invoice item ID. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttributeInput], - "invoice_id": "xyz789", - "invoice_item_id": "xyz789" -} -``` - - - -### InvoiceItemInterface - -Contains detailes about invoiced items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | - -#### Possible Types - -| InvoiceItemInterface Types | -|----------------| -| [`BundleInvoiceItem`](#bundleinvoiceitem) | -| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | -| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | -| [`InvoiceItem`](#invoiceitem) | - -#### Example - -```json -{ - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 -} -``` - - - -### InvoiceOutput - -Contains details about the invoice after adding custom attributes to it. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `invoice` - [`Invoice!`](#invoice) | The custom attributes to invoice have been added. | - -#### Example - -```json -{"invoice": Invoice} -``` - - - -### InvoiceTotal - -Contains price details from an invoice. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | - -#### Example - -```json -{ - "base_grand_total": Money, - "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money -} -``` - - - -### IsCompanyAdminEmailAvailableOutput - -Contains the response of a company admin email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsCompanyEmailAvailableOutput - -Contains the response of a company email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsCompanyRoleNameAvailableOutput - -Contains the response of a role name validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | - -#### Example - -```json -{"is_role_name_available": false} -``` - - - -### IsCompanyUserEmailAvailableOutput - -Contains the response of a company user email validation query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | - -#### Example - -```json -{"is_email_available": false} -``` - - - -### IsEmailAvailableOutput - -Contains the result of the `isEmailAvailable` query. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | - -#### Example - -```json -{"is_email_available": true} -``` - - - -### IsOperatorInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `type` - [`IsOperatorType`](#isoperatortype) | | -| `value` - [`Boolean`](#boolean) | | - -#### Example - -```json -{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true} -``` - - - -### IsOperatorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNKNOWN_ISOPERATOR_TYPE` | | -| `IS` | | - -#### Example - -```json -""UNKNOWN_ISOPERATOR_TYPE"" -``` - - - -### IsProductAlertSubscriptionResult - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `isSubscribed` - [`Boolean!`](#boolean) | | -| `message` - [`String`](#string) | | - -#### Example - -```json -{"isSubscribed": false, "message": "xyz789"} -``` - - - -### ItemNote - -The note object for quote line item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | -| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | -| `creator_name` - [`String`](#string) | Name of the creator. | -| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | -| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | -| `note` - [`String`](#string) | Note text. | -| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | - -#### Example - -```json -{ - "created_at": "abc123", - "creator_id": 123, - "creator_name": "abc123", - "creator_type": 123, - "negotiable_quote_item_uid": "4", - "note": "abc123", - "note_uid": 4 -} -``` - - - -### ItemSelectedBundleOption - -A list of options of the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The label of the option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | -| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | - -#### Example - -```json -{ - "label": "abc123", - "uid": 4, - "values": [ItemSelectedBundleOptionValue] -} -``` - - - -### ItemSelectedBundleOptionValue - -A list of values for the selected bundle product. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `price` - [`Money!`](#money) | The price of the child bundle product. | -| `product_name` - [`String!`](#string) | The name of the child bundle product. | -| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | -| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | -| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | - -#### Example - -```json -{ - "price": Money, - "product_name": "abc123", - "product_sku": "xyz789", - "quantity": 987.65, - "uid": 4 -} -``` - - - -### JSON - -A JSON scalar - -#### Example - -```json -{} -``` - - - -### KeyValue - -Contains a key-value pair. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name part of the key/value pair. | -| `value` - [`String`](#string) | The value part of the key/value pair. | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### LineItemNoteInput - -Sets quote item note. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `note` - [`String`](#string) | The note text to be added. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "note": "abc123", - "quote_item_uid": "4", - "quote_uid": 4 -} -``` - - - -### MediaGalleryInterface - -Contains basic information about a product image or video. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | - -#### Possible Types - -| MediaGalleryInterface Types | -|----------------| -| [`AssetImage`](#assetimage) | -| [`AssetVideo`](#assetvideo) | -| [`ProductImage`](#productimage) | -| [`ProductVideo`](#productvideo) | - -#### Example - -```json -{ - "disabled": true, - "label": "xyz789", - "position": 987, - "url": "abc123" -} -``` - - - -### MediaResourceType - -Enumeration of media resource types - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""NEGOTIABLE_QUOTE_ATTACHMENT"" -``` - - - -### MessageStyleLogo - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | - -#### Example - -```json -{"type": "abc123"} -``` - - - -### MessageStyles - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `layout` - [`String`](#string) | The message layout | -| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | - -#### Example - -```json -{ - "layout": "xyz789", - "logo": MessageStyleLogo -} -``` - - - -### Money - -Defines a monetary value, including a numeric value and a currency code. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](#float) | A number expressing a monetary value. | - -#### Example - -```json -{"currency": "AFN", "value": 123.45} -``` - - - -### MoveCartItemsToGiftRegistryOutput - -Contains the customer's gift registry and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | -| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | - -#### Example - -```json -{ - "gift_registry": GiftRegistry, - "status": true, - "user_errors": [GiftRegistryItemsUserError] -} -``` - - - -### MoveItemsBetweenRequisitionListsInput - -An input object that defines the items in a requisition list to be moved. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | - -#### Example - -```json -{"requisitionListItemUids": ["4"]} -``` - - - -### MoveItemsBetweenRequisitionListsOutput - -Output of the request to move items to another requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | -| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | - -#### Example - -```json -{ - "destination_requisition_list": RequisitionList, - "source_requisition_list": RequisitionList -} -``` - - - -### MoveLineItemToRequisitionListInput - -Move Line Item to Requisition List. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | - -#### Example - -```json -{ - "quote_item_uid": "4", - "quote_uid": 4, - "requisition_list_uid": 4 -} -``` - - - -### MoveLineItemToRequisitionListOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### MoveProductsBetweenWishlistsOutput - -Contains the source and target wish lists after moving products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | - -#### Example - -```json -{ - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] -} -``` - - - -### NegotiableQuote - -Contains details about a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | -| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the negotiable quote | -| `email` - [`String`](#string) | The email address of the company user. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | -| `order` - [`CustomerOrder`](#customerorder) | The order created from the negotiable quote. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | -| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | -| `template_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `template_name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | - -#### Example - -```json -{ - "available_payment_methods": [AvailablePaymentMethod], - "billing_address": NegotiableQuoteBillingAddress, - "buyer": NegotiableQuoteUser, - "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "custom_attributes": [CustomAttribute], - "email": "xyz789", - "expiration_date": "abc123", - "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, - "items": [CartItemInterface], - "name": "abc123", - "order": CustomerOrder, - "prices": CartPrices, - "sales_rep_name": "xyz789", - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "SUBMITTED", - "template_id": "4", - "template_name": "xyz789", - "total_quantity": 987.65, - "uid": "4", - "updated_at": "abc123" -} -``` - - - -### NegotiableQuoteAddressCountry - -Defines the company's country. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The address country code. | -| `label` - [`String!`](#string) | The display name of the region. | - -#### Example - -```json -{ - "code": "abc123", - "label": "abc123" -} -``` - - - -### NegotiableQuoteAddressInput - -Defines the billing or shipping address to be applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company name. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping negotiable quote address. | -| `fax` - [`String`](#string) | The fax number of the customer. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "city": "abc123", - "company": "abc123", - "country_code": "xyz789", - "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", - "region": "xyz789", - "region_id": 987, - "save_in_address_book": true, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "abc123" -} -``` - - - -### NegotiableQuoteAddressInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](#string) | The fax number of the customer. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `uid` - [`ID!`](#id) | The unique identifier of the negotiable quote address. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Possible Types - -| NegotiableQuoteAddressInterface Types | -|----------------| -| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | -| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", - "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": 4, - "vat_id": "xyz789" -} -``` - - - -### NegotiableQuoteAddressRegion - -Defines the company's state or province. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The address region code. | -| `label` - [`String`](#string) | The display name of the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | - -#### Example - -```json -{ - "code": "xyz789", - "label": "abc123", - "region_id": 987 -} -``` - - - -### NegotiableQuoteBillingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](#string) | The fax number of the customer. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `uid` - [`ID!`](#id) | The unique identifier of the negotiable quote address. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "city": "xyz789", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", - "region": NegotiableQuoteAddressRegion, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, - "vat_id": "xyz789" -} -``` - - - -### NegotiableQuoteBillingAddressInput - -Defines the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | -| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "same_as_shipping": false, - "use_for_shipping": true -} -``` - - - -### NegotiableQuoteComment - -Contains a single plain text comment from either the buyer or seller. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `attachments` - [`[NegotiableQuoteCommentAttachment]!`](#negotiablequotecommentattachment) | Negotiable quote comment file attachments. | -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | -| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | -| `text` - [`String!`](#string) | The plain text comment. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | - -#### Example - -```json -{ - "attachments": [NegotiableQuoteCommentAttachment], - "author": NegotiableQuoteUser, - "created_at": "abc123", - "creator_type": "BUYER", - "text": "abc123", - "uid": 4 -} -``` - - - -### NegotiableQuoteCommentAttachment - -Negotiable quote comment file attachment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | Negotiable quote comment attachment file name. | -| `url` - [`String!`](#string) | Negotiable quote comment attachment file url. | - -#### Example - -```json -{ - "name": "abc123", - "url": "xyz789" -} -``` - - - -### NegotiableQuoteCommentAttachmentInput - -Negotiable quote comment file attachment. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `key` - [`String!`](#string) | Negotiable quote comment attachment file key. | - -#### Example - -```json -{"key": "abc123"} -``` - - - -### NegotiableQuoteCommentCreatorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BUYER` | | -| `SELLER` | | - -#### Example - -```json -""BUYER"" -``` - - - -### NegotiableQuoteCommentInput - -Contains the commend provided by the buyer. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote comment file attachments. | -| `comment` - [`String!`](#string) | The comment provided by the buyer. | - -#### Example - -```json -{ - "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "abc123" -} -``` - - - -### NegotiableQuoteCustomLogChange - -Contains custom log entries added by third-party extensions. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_value` - [`String!`](#string) | The new entry content. | -| `old_value` - [`String`](#string) | The previous entry in the custom log. | -| `title` - [`String!`](#string) | The title of the custom log entry. | - -#### Example - -```json -{ - "new_value": "xyz789", - "old_value": "abc123", - "title": "abc123" -} -``` - - - -### NegotiableQuoteFilterInput - -Defines a filter to limit the negotiable quotes to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | - -#### Example - -```json -{ - "ids": FilterEqualTypeInput, - "name": FilterMatchTypeInput -} -``` - - - -### NegotiableQuoteHistoryChanges - -Contains a list of changes to a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | - -#### Example - -```json -{ - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange -} -``` - - - -### NegotiableQuoteHistoryCommentChange - -Contains a comment submitted by a seller or buyer. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | - -#### Example - -```json -{"comment": "abc123"} -``` - - - -### NegotiableQuoteHistoryEntry - -Contains details about a change for a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | -| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | -| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | -| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | -| `item_note` - [`HistoryItemNoteData`](#historyitemnotedata) | Item note data that is added to the negotiable quote history object. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | - -#### Example - -```json -{ - "author": NegotiableQuoteUser, - "change_type": "CREATED", - "changes": NegotiableQuoteHistoryChanges, - "created_at": "xyz789", - "item_note": HistoryItemNoteData, - "uid": 4 -} -``` - - - -### NegotiableQuoteHistoryEntryChangeType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `CREATED` | | -| `UPDATED` | | -| `CLOSED` | | -| `UPDATED_BY_SYSTEM` | | - -#### Example - -```json -""CREATED"" -``` - - - -### NegotiableQuoteHistoryExpirationChange - -Contains a new expiration date and the previous date. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | -| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | - -#### Example - -```json -{ - "new_expiration": "abc123", - "old_expiration": "xyz789" -} -``` - - - -### NegotiableQuoteHistoryProductsRemovedChange - -Contains lists of products that have been removed from the catalog and negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | -| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. *(Deprecated: Product information is part of a composable Catalog Service.)* | - -#### Example - -```json -{ - "products_removed_from_catalog": ["4"], - "products_removed_from_quote": [ProductInterface] -} -``` - - - -### NegotiableQuoteHistoryStatusChange - -Lists a new status change applied to a negotiable quote and the previous status. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | -| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | - -#### Example - -```json -{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} -``` - - - -### NegotiableQuoteHistoryStatusesChange - -Contains a list of status changes that occurred for the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | - -#### Example - -```json -{"changes": [NegotiableQuoteHistoryStatusChange]} -``` - - - -### NegotiableQuoteHistoryTotalChange - -Contains a new price and the previous price. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `new_price` - [`Money`](#money) | The total price as a result of the change. | -| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | - -#### Example - -```json -{ - "new_price": Money, - "old_price": Money -} -``` - - - -### NegotiableQuoteInvalidStateError - -An error indicating that an operation was attempted on a negotiable quote in an invalid state. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | - -#### Example - -```json -{"message": "abc123"} -``` - - - -### NegotiableQuoteItemQuantityInput - -Specifies the updated quantity of an item. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | -| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | - -#### Example - -```json -{"quantity": 123.45, "quote_item_uid": 4} -``` - - - -### NegotiableQuotePaymentMethodInput - -Defines the payment method to be applied to the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `code` - [`String!`](#string) | Payment method code | -| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | - -#### Example - -```json -{ - "code": "abc123", - "purchase_order_number": "xyz789" -} -``` - - - -### NegotiableQuoteReferenceDocumentLink - -Contains a reference document link for a negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `document_identifier` - [`String`](#string) | The identifier of the reference document. | -| `document_name` - [`String!`](#string) | The title of the reference document. | -| `link_id` - [`ID!`](#id) | The unique ID of a reference document link. | -| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | - -#### Example - -```json -{ - "document_identifier": "xyz789", - "document_name": "xyz789", - "link_id": "4", - "reference_document_url": "xyz789" -} -``` - - - -### NegotiableQuoteShippingAddress - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | -| `city` - [`String!`](#string) | The company's city or town. | -| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | -| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | -| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](#string) | The fax number of the customer. | -| `firstname` - [`String!`](#string) | The first name of the company user. | -| `lastname` - [`String!`](#string) | The last name of the company user. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The company's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The customer's telephone number. | -| `uid` - [`ID!`](#id) | The unique identifier of the negotiable quote address. | -| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | - -#### Example - -```json -{ - "available_shipping_methods": [AvailableShippingMethod], - "city": "abc123", - "company": "xyz789", - "country": NegotiableQuoteAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", - "region": NegotiableQuoteAddressRegion, - "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, - "vat_id": "abc123" -} -``` - - - -### NegotiableQuoteShippingAddressInput - -Defines shipping addresses for the negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | - -#### Example - -```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "xyz789" -} -``` - - - -### NegotiableQuoteSortInput - -Defines the field to use to sort a list of negotiable quotes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} -``` - - - -### NegotiableQuoteSortableField - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""QUOTE_NAME"" -``` - - - -### NegotiableQuoteStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SUBMITTED` | | -| `PENDING` | | -| `UPDATED` | | -| `OPEN` | | -| `ORDERED` | | -| `CLOSED` | | -| `DECLINED` | | -| `EXPIRED` | | -| `DRAFT` | | - -#### Example - -```json -""SUBMITTED"" -``` - - - -### NegotiableQuoteTemplate - -Contains details about a negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | -| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was created. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | -| `historyV2` - [`[NegotiableQuoteTemplateHistoryEntry]`](#negotiablequotetemplatehistoryentry) | | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | -| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteReferenceDocumentLink]`](#negotiablequotereferencedocumentlink) | A list of reference document links for the negotiable quote template. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `updated_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was updated. | - -#### Example - -```json -{ - "buyer": NegotiableQuoteUser, - "comments": [NegotiableQuoteComment], - "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, - "min_order_commitment": 987, - "name": "abc123", - "notifications": [QuoteTemplateNotificationMessage], - "prices": CartPrices, - "reference_document_links": [ - NegotiableQuoteReferenceDocumentLink - ], - "sales_rep_name": "xyz789", - "shipping_addresses": [NegotiableQuoteShippingAddress], - "status": "xyz789", - "template_id": "4", - "total_quantity": 987.65, - "uid": 4, - "updated_at": "abc123" -} -``` - - - -### NegotiableQuoteTemplateFilterInput - -Defines a filter to limit the negotiable quotes to return. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | -| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | - -#### Example - -```json -{ - "state": FilterEqualTypeInput, - "status": FilterEqualTypeInput -} -``` - - - -### NegotiableQuoteTemplateGridItem - -Contains data for a negotiable quote template in a grid. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | -| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was created. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_ordered_at` - [`String!`](#string) | Timestamp indicating when the last negotiable quote template order was placed. | -| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `state` - [`String!`](#string) | State of the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `updated_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was updated. | - -#### Example - -```json -{ - "activated_at": "abc123", - "company_name": "abc123", - "created_at": "abc123", - "expiration_date": "abc123", - "is_min_max_qty_used": false, - "last_ordered_at": "abc123", - "last_shared_at": "xyz789", - "max_order_commitment": 987, - "min_negotiated_grand_total": 987.65, - "min_order_commitment": 123, - "name": "abc123", - "orders_placed": 987, - "prices": CartPrices, - "sales_rep_name": "abc123", - "state": "abc123", - "status": "xyz789", - "submitted_by": "xyz789", - "template_id": 4, - "uid": 4, - "updated_at": "xyz789" -} -``` - - - -### NegotiableQuoteTemplateHistoryChanges - -Contains a list of changes to a negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteTemplateHistoryStatusesChange`](#negotiablequotetemplatehistorystatuseschange) | The status before and after a change in the negotiable quote template history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | - -#### Example - -```json -{ - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteTemplateHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange -} -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md new file mode 100644 index 000000000..e75b657d1 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md @@ -0,0 +1,2347 @@ +## Types + +### AcceptNegotiableQuoteTemplateInput + +Specifies the quote template id to accept quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": 4} +``` + + + +### AddCustomAttributesToCartItemOutput + +Contains details about the cart after adding custom attributes to it items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The custom attributes to cart item have been added. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddDownloadableProductsToCartInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID of the cart. | +| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | + +#### Example + +```json +{ + "cart_id": "abc123", + "cart_items": [DownloadableProductCartItemInput] +} +``` + + + +### AddDownloadableProductsToCartOutput + +Contains details about the cart after adding downloadable products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after adding products. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AddGiftRegistryRegistrantInput + +Defines a new registrant. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `email` - [`String!`](#string) | The email address of the registrant. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "email": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789" +} +``` + + + +### AddGiftRegistryRegistrantsOutput + +Contains the results of a request to add registrants. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### AddProductsToCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after products have been added. | +| `user_errors` - [`[Error]!`](#error) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [Error] +} +``` + + + +### AddProductsToCompareListInput + +Contains products to add to an existing compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{ + "products": ["4"], + "uid": "4" +} +``` + + + +### AddProductsToNewCartOutput + +Contains details about the cart after adding products to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after products have been added. | +| `user_errors` - [`[CartUserInputError]`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [CartUserInputError] +} +``` + + + +### AddProductsToRequisitionListOutput + +Output of the request to add products to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | + +#### Example + +```json +{"requisition_list": RequisitionList} +``` + + + +### AddProductsToWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### AddPurchaseOrderCommentInput + +Contains the comment to be added to a purchase order. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | Comment text. | +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | + +#### Example + +```json +{ + "comment": "xyz789", + "purchase_order_uid": "4" +} +``` + + + +### AddPurchaseOrderCommentOutput + +Contains the successfully added comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | + +#### Example + +```json +{"comment": PurchaseOrderComment} +``` + + + +### AddPurchaseOrderItemsToCartInput + +Defines the purchase order and cart to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | +| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | +| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | + +#### Example + +```json +{ + "cart_id": "abc123", + "purchase_order_uid": "4", + "replace_existing_cart_items": false +} +``` + + + +### AddRequisitionListItemToCartUserError + +Contains details about why an attempt to add items to the requistion list failed. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | A description of the error. | +| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | + +#### Example + +```json +{ + "message": "abc123", + "type": "OUT_OF_STOCK" +} +``` + + + +### AddRequisitionListItemToCartUserErrorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `OUT_OF_STOCK` | | +| `UNAVAILABLE_SKU` | | +| `OPTIONS_UPDATED` | | +| `LOW_QUANTITY` | | + +#### Example + +```json +""OUT_OF_STOCK"" +``` + + + +### AddRequisitionListItemsToCartOutput + +Output of the request to add items in a requisition list to the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | +| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | + +#### Example + +```json +{ + "add_requisition_list_items_to_cart_user_errors": [ + AddRequisitionListItemToCartUserError + ], + "cart": Cart, + "status": false +} +``` + + + +### AddReturnCommentInput + +Defines a return comment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String!`](#string) | The text added to the return request. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "comment_text": "abc123", + "return_uid": "4" +} +``` + + + +### AddReturnCommentOutput + +Contains details about the return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | The modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### AddReturnTrackingInput + +Defines tracking information to be added to the return. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | +| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | +| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | + +#### Example + +```json +{ + "carrier_uid": "4", + "return_uid": "4", + "tracking_number": "abc123" +} +``` + + + +### AddReturnTrackingOutput + +Contains the response after adding tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about the modified return. | +| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | + +#### Example + +```json +{ + "return": Return, + "return_shipping_tracking": ReturnShippingTracking +} +``` + + + +### AddWishlistItemsToCartOutput + +Contains the resultant wish list and any error information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | + +#### Example + +```json +{ + "add_wishlist_items_to_cart_user_errors": [ + WishlistCartUserInputError + ], + "status": false, + "wishlist": Wishlist +} +``` + + + +### AdminAssistanceAction + +A single admin assistance action performed on behalf of the customer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `action` - [`String!`](#string) | Action identifier, e.g. add_to_cart, place_order. | +| `date` - [`String!`](#string) | When the action occurred. | +| `details` - [`String`](#string) | Action related details, e.g. product SKUs, order id. | + +#### Example + +```json +{ + "action": "abc123", + "date": "abc123", + "details": "xyz789" +} +``` + + + +### AdminAssistanceActions + +Paginated admin assistance actions for the customer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[AdminAssistanceAction]!`](#adminassistanceaction) | Admin assistance actions for the current page. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int!`](#int) | The total count of admin assistance actions for the customer. | + +#### Example + +```json +{ + "items": [AdminAssistanceAction], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### Aggregation + +A bucket that contains information for each filterable option + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute` - [`String!`](#string) | The attribute code of the filter item | +| `buckets` - [`[Bucket]!`](#bucket) | A container that divides the data into manageable groups. For example, attributes that can have numeric values might have buckets that define price ranges | +| `title` - [`String!`](#string) | The filter name displayed in layered navigation | +| `type` - [`AggregationType`](#aggregationtype) | Identifies the data type of the aggregation | + +#### Example + +```json +{ + "attribute": "abc123", + "buckets": [Bucket], + "title": "abc123", + "type": "INTELLIGENT" +} +``` + + + +### AggregationType + +Identifies the data type of the aggregation + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INTELLIGENT` | | +| `PINNED` | | +| `POPULAR` | | + +#### Example + +```json +""INTELLIGENT"" +``` + + + +### ApplePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": ButtonStyles, + "code": "abc123", + "is_visible": true, + "payment_intent": "xyz789", + "payment_source": "xyz789", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "abc123" +} +``` + + + +### ApplePayMethodInput + +Apple Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "abc123" +} +``` + + + +### AppliedCoupon + +Contains the applied coupon code. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | + +#### Example + +```json +{"code": "xyz789"} +``` + + + +### AppliedGiftCard + +Contains an applied gift card with applied and remaining balance. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | +| `code` - [`String`](#string) | The gift card account code. | +| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "abc123", + "current_balance": Money, + "expiration_date": "xyz789" +} +``` + + + +### AppliedQueryRule + +The rule that was applied to this product + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `action_type` - [`AppliedQueryRuleActionType`](#appliedqueryruleactiontype) | An enum that defines the type of rule that was applied | +| `rule_id` - [`String`](#string) | The ID assigned to the rule | +| `rule_name` - [`String`](#string) | The name of the applied rule | + +#### Example + +```json +{ + "action_type": "BOOST", + "rule_id": "xyz789", + "rule_name": "xyz789" +} +``` + + + +### AppliedQueryRuleActionType + +The type of rule that was applied to a product during search (optional) + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOST` | | +| `BURY` | | +| `PIN` | | + +#### Example + +```json +""BOOST"" +``` + + + +### AppliedStoreCredit + +Contains the applied and current balances. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | +| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | + +#### Example + +```json +{ + "applied_balance": Money, + "current_balance": Money, + "enabled": false +} +``` + + + +### ApplyCouponToCartInput + +Specifies the coupon code to apply to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_code` - [`String!`](#string) | A valid coupon code. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "coupon_code": "abc123" +} +``` + + + +### ApplyCouponToCartOutput + +Contains details about the cart after applying a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyCouponsStrategy + +The strategy to apply coupons to the cart. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""APPEND"" +``` + + + +### ApplyCouponsToCartInput + +Apply coupons to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | +| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | + +#### Example + +```json +{ + "cart_id": "abc123", + "coupon_codes": ["abc123"], + "type": "APPEND" +} +``` + + + +### ApplyGiftCardToCartInput + +Defines the input required to run the `applyGiftCardToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | + +#### Example + +```json +{ + "cart_id": "abc123", + "gift_card_code": "xyz789" +} +``` + + + +### ApplyGiftCardToCartOutput + +Defines the possible output for the `applyGiftCardToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyGiftCardToOrder + +Contains applied gift cards with gift card code and amount. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | +| `code` - [`String!`](#string) | The gift card account code. | + +#### Example + +```json +{ + "applied_balance": Money, + "code": "abc123" +} +``` + + + +### ApplyRewardPointsToCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ApplyStoreCreditToCartInput + +Defines the input required to run the `applyStoreCreditToCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### ApplyStoreCreditToCartOutput + +Defines the possible output for the `applyStoreCreditToCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### AreaInput + +AreaInput defines the parameters which will be used for filter by specified location. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `radius` - [`Int!`](#int) | The radius for the search in KM. | +| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | + +#### Example + +```json +{"radius": 123, "search_term": "xyz789"} +``` + + + +### AssetImage + +Contains information about an asset image. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `asset_image` - [`ProductMediaGalleryEntriesAssetImage`](#productmediagalleryentriesassetimage) | Contains a `ProductMediaGalleryEntriesAssetImage` object. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Example + +```json +{ + "asset_image": ProductMediaGalleryEntriesAssetImage, + "disabled": true, + "label": "abc123", + "position": 123, + "url": "xyz789" +} +``` + + + +### AssetVideo + +Contains information about an asset video. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `asset_video` - [`ProductMediaGalleryEntriesAssetVideo`](#productmediagalleryentriesassetvideo) | Contains a `ProductMediaGalleryEntriesAssetVideo` object. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Example + +```json +{ + "asset_video": ProductMediaGalleryEntriesAssetVideo, + "disabled": false, + "label": "abc123", + "position": 987, + "url": "abc123" +} +``` + + + +### AssignChildCompanyInput + +Defines the input schema for assigning a child company to a parent company. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `child_company_id` - [`ID!`](#id) | The unique ID of the child company. | +| `parent_company_id` - [`ID!`](#id) | The unique ID of the parent company. | + +#### Example + +```json +{ + "child_company_id": 4, + "parent_company_id": "4" +} +``` + + + +### AssignChildCompanyOutput + +Contains the response to the request to assign a child company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company_hierarchy` - [`CompanyHierarchy!`](#companyhierarchy) | The updated company hierarchy for the parent company. | + +#### Example + +```json +{"company_hierarchy": CompanyHierarchy} +``` + + + +### AssignCompareListToCustomerOutput + +Contains the results of the request to assign a compare list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | + +#### Example + +```json +{"compare_list": CompareList, "result": false} +``` + + + +### AttributeEntityTypeEnum + +List of all entity types. Populated by the modules introducing EAV entities. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `CATALOG_PRODUCT` | | +| `CATALOG_CATEGORY` | | +| `CUSTOMER` | | +| `CUSTOMER_ADDRESS` | | +| `RMA_ITEM` | | + +#### Example + +```json +""CATALOG_PRODUCT"" +``` + + + +### AttributeFile + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_type` - [`String`](#string) | Attribute type code. | +| `code` - [`ID!`](#id) | The attribute code. | +| `url` - [`String!`](#string) | File URL to download the file. | +| `value` - [`String!`](#string) | File code. For file download use `url` field. | + +#### Example + +```json +{ + "attribute_type": "abc123", + "code": 4, + "url": "xyz789", + "value": "abc123" +} +``` + + + +### AttributeFilterInput + +An input object that specifies the filters used for attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | + +#### Example + +```json +{ + "is_comparable": false, + "is_filterable": true, + "is_filterable_in_search": false, + "is_html_allowed_on_front": false, + "is_searchable": false, + "is_used_for_customer_segment": 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, + "used_in_product_listing": true +} +``` + + + +### AttributeFrontendInputEnum + +EAV attribute frontend input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `WEIGHT` | | +| `UNDEFINED` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### AttributeImage + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_type` - [`String`](#string) | Attribute type code. | +| `code` - [`ID!`](#id) | The attribute code. | +| `url` - [`String!`](#string) | Image URL to download the image. | +| `value` - [`String!`](#string) | Image code. For image download use `url` field. | + +#### Example + +```json +{ + "attribute_type": "abc123", + "code": 4, + "url": "xyz789", + "value": "xyz789" +} +``` + + + +### AttributeInput + +Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "entity_type": "xyz789" +} +``` + + + +### AttributeInputSelectedOption + +Specifies selected option for a select or multiselect attribute value. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{"value": "abc123"} +``` + + + +### AttributeMetadata + +Base EAV implementation of CustomAttributeMetadataInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | + +#### Example + +```json +{ + "code": "4", + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "is_required": false, + "is_unique": false, + "label": "abc123", + "options": [CustomAttributeOptionInterface] +} +``` + + + +### AttributeMetadataError + +Attribute metadata retrieval error. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | +| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | + +#### Example + +```json +{ + "message": "xyz789", + "type": "ENTITY_NOT_FOUND" +} +``` + + + +### AttributeMetadataErrorType + +Attribute metadata retrieval error types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ENTITY_NOT_FOUND"" +``` + + + +### AttributeMetadataResponse + +Contains the output of the `attributeMetadata` query + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `filterableInSearch` - [`[FilterableInSearchAttribute!]`](#filterableinsearchattribute) | An array of product attributes that can be used for filtering in a `productSearch` query | +| `sortable` - [`[SortableAttribute!]`](#sortableattribute) | An array of product attributes that can be used for sorting in a `productSearch` query | + +#### Example + +```json +{ + "filterableInSearch": [FilterableInSearchAttribute], + "sortable": [SortableAttribute] +} +``` + + + +### AttributeOptionMetadata + +Base EAV implementation of CustomAttributeOptionInterface. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | + +#### Example + +```json +{ + "is_default": false, + "label": "abc123", + "value": "xyz789" +} +``` + + + +### AttributeSelectedOption + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### AttributeSelectedOptionInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The attribute selected option label. | +| `value` - [`String!`](#string) | The attribute selected option value. | + +#### Possible Types + +| AttributeSelectedOptionInterface Types | +|----------------| +| [`AttributeSelectedOption`](#attributeselectedoption) | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### AttributeSelectedOptions + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_type` - [`String`](#string) | Attribute type code. | +| `code` - [`ID!`](#id) | The attribute code. | +| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | + +#### Example + +```json +{ + "attribute_type": "abc123", + "code": "4", + "selected_options": [AttributeSelectedOptionInterface] +} +``` + + + +### AttributeValue + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_type` - [`String`](#string) | Attribute type code. | +| `code` - [`ID!`](#id) | The attribute code. | +| `value` - [`String!`](#string) | The attribute value. | + +#### Example + +```json +{ + "attribute_type": "xyz789", + "code": 4, + "value": "abc123" +} +``` + + + +### AttributeValueInput + +Specifies the value for attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | The code of the attribute. | +| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | +| `value` - [`String`](#string) | The value assigned to the attribute. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "selected_options": [AttributeInputSelectedOption], + "value": "xyz789" +} +``` + + + +### AttributeValueInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_type` - [`String`](#string) | Attribute type code. | +| `code` - [`ID!`](#id) | The attribute code. | + +#### Possible Types + +| AttributeValueInterface Types | +|----------------| +| [`AttributeFile`](#attributefile) | +| [`AttributeImage`](#attributeimage) | +| [`AttributeSelectedOptions`](#attributeselectedoptions) | +| [`AttributeValue`](#attributevalue) | +| [`ProductAttributeFile`](#productattributefile) | + +#### Example + +```json +{"attribute_type": "xyz789", "code": 4} +``` + + + +### AttributesFormOutput + +Metadata of EAV attributes associated to form + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AttributesMetadataOutput + +Metadata of EAV attributes. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | +| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | + +#### Example + +```json +{ + "errors": [AttributeMetadataError], + "items": [CustomAttributeMetadataInterface] +} +``` + + + +### AvailableCurrency + +Defines the code and symbol of a currency that can be used for purchase orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | +| `symbol` - [`String!`](#string) | Currency symbol, for example $. | + +#### Example + +```json +{"code": "AFN", "symbol": "abc123"} +``` + + + +### AvailablePaymentMethod + +Describes a payment method that the shopper can use to pay for the order. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | +| `oope_payment_method_config` - [`OopePaymentMethodConfig`](#oopepaymentmethodconfig) | Configuration for out of process payment methods | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "abc123", + "is_deferred": false, + "oope_payment_method_config": OopePaymentMethodConfig, + "title": "abc123" +} +``` + + + +### AvailableShippingMethod + +Contains details about the possible shipping methods and carriers. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `additional_data` - [`[ShippingAdditionalData]`](#shippingadditionaldata) | Additional data related to the shipping method. | +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `error_message` - [`String`](#string) | Describes an error condition. | +| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | +| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "additional_data": [ShippingAdditionalData], + "amount": Money, + "available": true, + "carrier_code": "abc123", + "carrier_title": "xyz789", + "error_message": "xyz789", + "method_code": "xyz789", + "method_title": "xyz789", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### BatchMutationStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUCCESS` | | +| `FAILURE` | | +| `MIXED_RESULTS` | | + +#### Example + +```json +""SUCCESS"" +``` + + + +### BillingAddressInput + +Defines the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for billing. | +| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | +| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 123, + "customer_address_uid": "4", + "same_as_shipping": true, + "use_for_shipping": true +} +``` + + + +### BillingAddressPaymentSourceInput + +The billing address information + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_line_1` - [`String`](#string) | The first line of the address | +| `address_line_2` - [`String`](#string) | The second line of the address | +| `city` - [`String`](#string) | The city of the address | +| `country_code` - [`String!`](#string) | The country of the address | +| `postal_code` - [`String`](#string) | The postal code of the address | +| `region` - [`String`](#string) | The region of the address | + +#### Example + +```json +{ + "address_line_1": "xyz789", + "address_line_2": "xyz789", + "city": "abc123", + "country_code": "xyz789", + "postal_code": "xyz789", + "region": "abc123" +} +``` + + + +### BillingCartAddress + +Contains details about the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "city": "abc123", + "company": "xyz789", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": 4, + "fax": "xyz789", + "firstname": "abc123", + "id": 123, + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", + "region": CartAddressRegion, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "abc123", + "uid": "4", + "vat_id": "abc123" +} +``` + + + +### Boolean + +The `Boolean` scalar type represents `true` or `false`. + +#### Example + +```json +true +``` + + + +### Breadcrumb + +Contains details about an individual category that comprises a breadcrumb. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `category_level` - [`Int`](#int) | The category level. | +| `category_name` - [`String`](#string) | The display name of the category. | +| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | +| `category_url_key` - [`String`](#string) | The URL key of the category. | +| `category_url_path` - [`String`](#string) | The URL path of the category. | + +#### Example + +```json +{ + "category_level": 123, + "category_name": "xyz789", + "category_uid": "4", + "category_url_key": "abc123", + "category_url_path": "abc123" +} +``` + + + +### Bucket + +An interface for bucket contents + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `title` - [`String!`](#string) | A human-readable name of a bucket | + +#### Possible Types + +| Bucket Types | +|----------------| +| [`CategoryBucket`](#categorybucket) | +| [`CategoryView`](#categoryview) | +| [`RangeBucket`](#rangebucket) | +| [`ScalarBucket`](#scalarbucket) | +| [`StatsBucket`](#statsbucket) | + +#### Example + +```json +{"title": "xyz789"} +``` + + + +### BundleCartItem + +An implementation for bundle product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "available_gift_wrapping": [GiftWrapping], + "backorder_message": "abc123", + "bundle_options": [SelectedBundleOption], + "custom_attributes": [CustomAttribute], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "is_available": false, + "is_salable": 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 +} +``` + + + +### BundleCreditMemoItem + +Defines bundle product options for `CreditMemoItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 +} +``` + + + +### BundleInvoiceItem + +Defines bundle product options for `InvoiceItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 987.65 +} +``` + + + +### BundleItem + +Defines an individual item within a bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | +| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | +| `sku` - [`String`](#string) | The SKU of the bundle product. | +| `title` - [`String`](#string) | The display name of the item. | +| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | +| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | + +#### Example + +```json +{ + "options": [BundleItemOption], + "position": 123, + "price_range": PriceRange, + "required": false, + "sku": "xyz789", + "title": "abc123", + "type": "abc123", + "uid": 4 +} +``` + + + +### BundleItemOption + +Defines the characteristics that comprise a specific bundle item and its options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | +| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | +| `label` - [`String`](#string) | The text that identifies the bundled item option. | +| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | +| `price` - [`Float`](#float) | The price of the selected option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | +| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | +| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | +| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | + +#### Example + +```json +{ + "can_change_quantity": false, + "is_default": true, + "label": "abc123", + "position": 987, + "price": 123.45, + "price_type": "FIXED", + "product": ProductInterface, + "quantity": 987.65, + "uid": 4 +} +``` + + + +### BundleOrderItem + +Defines bundle product options for `OrderItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "eligible_for_return": true, + "entered_options": [OrderItemOption], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "id": "4", + "parent_sku": "abc123", + "prices": OrderItemPrices, + "product": ProductInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "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": "xyz789" +} +``` + + + +### BundleProduct + +Defines basic features of a bundle product and contains multiple BundleItems. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | +| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | +| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "canonical_url": "abc123", + "categories": [CategoryInterface], + "country_of_manufacture": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "dynamic_price": false, + "dynamic_sku": false, + "dynamic_weight": false, + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "image": ProductImage, + "is_returnable": "xyz789", + "items": [BundleItem], + "manufacturer": 987, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price_details": PriceDetails, + "price_range": PriceRange, + "price_tiers": [TierPrice], + "price_view": "PRICE_RANGE", + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "related_products": [ProductInterface], + "ship_bundle_items": "TOGETHER", + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_price": 123.45, + "special_to_date": "abc123", + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "thumbnail": ProductImage, + "uid": "4", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "weight": 123.45 +} +``` + + + +### BundleRequisitionListItem + +Contains details about bundle products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `sku` - [`String!`](#string) | The product SKU. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | + +#### Example + +```json +{ + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 123.45, + "sku": "xyz789", + "uid": "4" +} +``` + + + +### BundleShipmentItem + +Defines bundle product options for `ShipmentItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "bundle_options": [ItemSelectedBundleOption], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 987.65 +} +``` + + + +### BundleWishlistItem + +Defines bundle product options for `WishlistItemInterface`. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "bundle_options": [SelectedBundleOption], + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### ButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `label` - [`String`](#string) | The button label | +| `layout` - [`String`](#string) | The button layout | +| `shape` - [`String`](#string) | The button shape | +| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | +| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | + +#### Example + +```json +{ + "color": "abc123", + "height": 987, + "label": "xyz789", + "layout": "abc123", + "shape": "abc123", + "tagline": false, + "use_default_height": false +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-1.md b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md similarity index 73% rename from src/pages/includes/autogenerated/graphql-api-saas-types-1.md rename to src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md index 63320df08..e37720790 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-1.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md @@ -1,6506 +1,6587 @@ ## Types -### AcceptNegotiableQuoteTemplateInput +### CancelNegotiableQuoteTemplateInput -Specifies the quote template id to accept quote template. +Specifies the quote template id of the quote template to cancel #### Input Fields | Input Field | Description | |-------------|-------------| +| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | | `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"template_id": "4"} +{ + "cancellation_comment": "xyz789", + "template_id": 4 +} ``` -### AddCustomAttributesToCartItemOutput - -Contains details about the cart after adding custom attributes to it items. +### CancelOrderError #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The custom attributes to cart item have been added. | +| `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json -{"cart": Cart} +{ + "code": "ORDER_CANCELLATION_DISABLED", + "message": "xyz789" +} +``` + + + +### CancelOrderErrorCode + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ORDER_CANCELLATION_DISABLED` | | +| `UNDEFINED` | | +| `UNAUTHORISED` | | +| `ORDER_NOT_FOUND` | | +| `PARTIAL_ORDER_ITEM_SHIPPED` | | +| `INVALID_ORDER_STATUS` | | + +#### Example + +```json +""ORDER_CANCELLATION_DISABLED"" ``` -### AddDownloadableProductsToCartInput +### CancelOrderInput + +Defines the order to cancel. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID of the cart. | -| `cart_items` - [`[DownloadableProductCartItemInput]!`](#downloadableproductcartiteminput) | An array of downloadable products to add. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +| `reason` - [`String!`](#string) | Cancellation reason. | #### Example ```json { - "cart_id": "abc123", - "cart_items": [DownloadableProductCartItemInput] + "order_id": "4", + "reason": "abc123" } ``` -### AddDownloadableProductsToCartOutput +### CancelOrderOutput -Contains details about the cart after adding downloadable products. +Contains the updated customer order and error message if any. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after adding products. | +| `error` - [`String`](#string) | Error encountered while cancelling the order. | +| `errorV2` - [`CancelOrderError`](#cancelordererror) | | +| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | #### Example ```json -{"cart": Cart} +{ + "error": "abc123", + "errorV2": CancelOrderError, + "order": CustomerOrder +} ``` -### AddGiftRegistryRegistrantInput - -Defines a new registrant. +### CancellationReason -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `email` - [`String!`](#string) | The email address of the registrant. | -| `firstname` - [`String!`](#string) | The first name of the registrant. | -| `lastname` - [`String!`](#string) | The last name of the registrant. | +| Field Name | Description | +|------------|-------------| +| `description` - [`String!`](#string) | | #### Example ```json -{ - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "email": "xyz789", - "firstname": "xyz789", - "lastname": "xyz789" -} +{"description": "abc123"} ``` -### AddGiftRegistryRegistrantsOutput - -Contains the results of a request to add registrants. +### Card #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after adding registrants. | +| `bin_details` - [`CardBin`](#cardbin) | Card bin details | +| `card_expiry_month` - [`String`](#string) | Expiration month of the card | +| `card_expiry_year` - [`String`](#string) | Expiration year of the card | +| `last_digits` - [`String`](#string) | Last four digits of the card | +| `name` - [`String`](#string) | Name on the card | #### Example ```json -{"gift_registry": GiftRegistry} +{ + "bin_details": CardBin, + "card_expiry_month": "abc123", + "card_expiry_year": "abc123", + "last_digits": "xyz789", + "name": "xyz789" +} ``` -### AddProductsToCartOutput - -Contains details about the cart after adding products to it. +### CardBin #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after products have been added. | -| `user_errors` - [`[Error]!`](#error) | Contains errors encountered while adding an item to the cart. | +| `bin` - [`String`](#string) | Card bin number | #### Example ```json -{ - "cart": Cart, - "user_errors": [Error] -} +{"bin": "abc123"} ``` -### AddProductsToCompareListInput +### CardPaymentSourceInput -Contains products to add to an existing compare list. +The card payment source information #### Input Fields | Input Field | Description | |-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to add to the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | +| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | +| `name` - [`String`](#string) | The name on the cardholder | #### Example ```json -{"products": ["4"], "uid": 4} +{ + "billing_address": BillingAddressPaymentSourceInput, + "name": "xyz789" +} ``` -### AddProductsToNewCartOutput +### CardPaymentSourceOutput -Contains details about the cart after adding products to it. +The card payment source information #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after products have been added. | -| `user_errors` - [`[CartUserInputError]`](#cartuserinputerror) | Contains errors encountered while adding an item to the cart. | +| `brand` - [`String`](#string) | The brand of the card | +| `expiry` - [`String`](#string) | The expiry of the card | +| `last_digits` - [`String`](#string) | The last digits of the card | #### Example ```json { - "cart": Cart, - "user_errors": [CartUserInputError] + "brand": "abc123", + "expiry": "abc123", + "last_digits": "abc123" } ``` -### AddProductsToRequisitionListOutput +### Cart -Output of the request to add products to a requisition list. +Contains the contents and other details about a guest or customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after adding products. | +| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | +| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | +| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | +| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | +| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | +| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart | +| `email` - [`String`](#string) | The email address of the guest or customer. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | +| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | +| `itemsV2` - [`CartItems`](#cartitems) | | +| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | +| `rules` - [`[CartRuleStorefront]`](#cartrulestorefront) | Provides applied cart rules in the current active cart | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | +| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "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, + "custom_attributes": [CustomAttribute], + "email": "xyz789", + "gift_message": GiftMessage, + "gift_receipt_included": true, + "gift_wrapping": GiftWrapping, + "id": 4, + "is_virtual": true, + "itemsV2": CartItems, + "prices": CartPrices, + "printed_card_included": false, + "rules": [CartRuleStorefront], + "selected_payment_method": SelectedPaymentMethod, + "shipping_addresses": [ShippingCartAddress], + "total_quantity": 987.65 +} ``` -### AddProductsToWishlistOutput +### CartAddressCountry -Contains the customer's wish list and any errors encountered. +Contains details the country in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while adding products to a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | +| `code` - [`String!`](#string) | The country code. | +| `label` - [`String!`](#string) | The display label for the country. | #### Example ```json { - "user_errors": [WishListUserInputError], - "wishlist": Wishlist + "code": "xyz789", + "label": "abc123" } ``` -### AddPurchaseOrderCommentInput +### CartAddressInput -Contains the comment to be added to a purchase order. +Defines the billing or shipping address to be applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment` - [`String!`](#string) | Comment text. | -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | #### Example ```json { - "comment": "xyz789", - "purchase_order_uid": "4" + "city": "xyz789", + "company": "xyz789", + "country_code": "xyz789", + "custom_attributes": [AttributeValueInput], + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "abc123", + "region": "xyz789", + "region_id": 123, + "save_in_address_book": true, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "xyz789" } ``` -### AddPurchaseOrderCommentOutput - -Contains the successfully added comment. +### CartAddressInterface #### Fields | Field Name | Description | |------------|-------------| -| `comment` - [`PurchaseOrderComment!`](#purchaseordercomment) | The purchase order comment. | - -#### Example - -```json -{"comment": PurchaseOrderComment} -``` - - - -### AddPurchaseOrderItemsToCartInput - -Defines the purchase order and cart to act on. +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The ID to assign to the cart. | -| `purchase_order_uid` - [`ID!`](#id) | Purchase order unique ID. | -| `replace_existing_cart_items` - [`Boolean!`](#boolean) | Replace existing cart or merge items. | +| CartAddressInterface Types | +|----------------| +| [`BillingCartAddress`](#billingcartaddress) | +| [`ShippingCartAddress`](#shippingcartaddress) | #### Example ```json { - "cart_id": "abc123", - "purchase_order_uid": 4, - "replace_existing_cart_items": true + "city": "xyz789", + "company": "abc123", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": 4, + "fax": "xyz789", + "firstname": "abc123", + "id": 123, + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CartAddressRegion, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "4", + "vat_id": "xyz789" } ``` -### AddRequisitionListItemToCartUserError +### CartAddressRegion -Contains details about why an attempt to add items to the requistion list failed. +Contains details about the region in a billing or shipping address. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | A description of the error. | -| `type` - [`AddRequisitionListItemToCartUserErrorType!`](#addrequisitionlistitemtocartusererrortype) | The type of error that occurred. | +| `code` - [`String`](#string) | The state or province code. | +| `label` - [`String`](#string) | The display label for the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "message": "xyz789", - "type": "OUT_OF_STOCK" + "code": "xyz789", + "label": "abc123", + "region_id": 123 } ``` -### AddRequisitionListItemToCartUserErrorType +### CartCustomAttributesInput -#### Values +Defines a cart custom attributes. -| Enum Value | Description | -|------------|-------------| -| `OUT_OF_STOCK` | | -| `UNAVAILABLE_SKU` | | -| `OPTIONS_UPDATED` | | -| `LOW_QUANTITY` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The cart ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart. | #### Example ```json -""OUT_OF_STOCK"" +{ + "cart_id": "xyz789", + "custom_attributes": [CustomAttributeInput] +} ``` -### AddRequisitionListItemsToCartOutput - -Output of the request to add items in a requisition list to the cart. +### CartDiscountType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `add_requisition_list_items_to_cart_user_errors` - [`[AddRequisitionListItemToCartUserError]!`](#addrequisitionlistitemtocartusererror) | Details about why the attempt to add items to the requistion list was not successful. | -| `cart` - [`Cart`](#cart) | The cart after adding requisition list items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the requisition list was successful. | +| `ITEM` | | +| `SHIPPING` | | #### Example ```json -{ - "add_requisition_list_items_to_cart_user_errors": [ - AddRequisitionListItemToCartUserError - ], - "cart": Cart, - "status": false -} +""ITEM"" ``` -### AddReturnCommentInput +### CartItemCustomAttributesInput -Defines a return comment. +Defines a cart item custom attributes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `comment_text` - [`String!`](#string) | The text added to the return request. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Return` object. | +| `cart_id` - [`String!`](#string) | The cart ID. | +| `cart_item_id` - [`String!`](#string) | The cart item ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart item. | #### Example ```json { - "comment_text": "abc123", - "return_uid": "4" + "cart_id": "xyz789", + "cart_item_id": "abc123", + "custom_attributes": [CustomAttributeInput] } ``` -### AddReturnCommentOutput - -Contains details about the return request. +### CartItemError #### Fields | Field Name | Description | |------------|-------------| -| `return` - [`Return`](#return) | The modified return. | +| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | +| `message` - [`String!`](#string) | A localized error message | #### Example ```json -{"return": Return} +{"code": "UNDEFINED", "message": "abc123"} ``` -### AddReturnTrackingInput - -Defines tracking information to be added to the return. +### CartItemErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `carrier_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object. | -| `return_uid` - [`ID!`](#id) | The unique ID for a `Returns` object. | -| `tracking_number` - [`String!`](#string) | The shipping tracking number for this return request. | +| Enum Value | Description | +|------------|-------------| +| `UNDEFINED` | | +| `ITEM_QTY` | | +| `ITEM_INCREMENTS` | | #### Example ```json -{ - "carrier_uid": 4, - "return_uid": 4, - "tracking_number": "xyz789" -} +""UNDEFINED"" ``` -### AddReturnTrackingOutput +### CartItemInput -Contains the response after adding tracking information. +Defines an item to be added to the cart. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `return` - [`Return`](#return) | Details about the modified return. | -| `return_shipping_tracking` - [`ReturnShippingTracking`](#returnshippingtracking) | Details about shipping for a return. | +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | +| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | +| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | +| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | #### Example ```json { - "return": Return, - "return_shipping_tracking": ReturnShippingTracking + "entered_options": [EnteredOptionInput], + "parent_sku": "abc123", + "quantity": 987.65, + "selected_options": [4], + "sku": "xyz789" } ``` -### AddWishlistItemsToCartOutput +### CartItemInterface -Contains the resultant wish list and any error information. +An interface for products in a cart. #### Fields | Field Name | Description | |------------|-------------| -| `add_wishlist_items_to_cart_user_errors` - [`[WishlistCartUserInputError]!`](#wishlistcartuserinputerror) | An array of errors encountered while adding products to the customer's cart. | -| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to add items to the customer's cart was successful. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with all items that were successfully added. | - -#### Example - -```json -{ - "add_wishlist_items_to_cart_user_errors": [ - WishlistCartUserInputError - ], - "status": true, - "wishlist": Wishlist -} -``` - - - -### AdminAssistanceAction - -A single admin assistance action performed on behalf of the customer. +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | -#### Fields +#### Possible Types -| Field Name | Description | -|------------|-------------| -| `action` - [`String!`](#string) | Action identifier, e.g. add_to_cart, place_order. | -| `date` - [`String!`](#string) | When the action occurred. | -| `details` - [`String`](#string) | Action related details, e.g. product SKUs, order id. | +| CartItemInterface Types | +|----------------| +| [`BundleCartItem`](#bundlecartitem) | +| [`ConfigurableCartItem`](#configurablecartitem) | +| [`DownloadableCartItem`](#downloadablecartitem) | +| [`GiftCardCartItem`](#giftcardcartitem) | +| [`SimpleCartItem`](#simplecartitem) | +| [`VirtualCartItem`](#virtualcartitem) | #### Example ```json { - "action": "abc123", - "date": "xyz789", - "details": "abc123" + "backorder_message": "abc123", + "custom_attributes": [CustomAttribute], + "discount": [Discount], + "errors": [CartItemError], + "is_available": true, + "is_salable": true, + "max_qty": 123.45, + "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" } ``` -### AdminAssistanceActions +### CartItemPrices -Paginated admin assistance actions for the customer. +Contains details about the price of the item, including taxes and discounts. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[AdminAssistanceAction]!`](#adminassistanceaction) | Admin assistance actions for the current page. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata. | -| `total_count` - [`Int!`](#int) | The total count of admin assistance actions for the customer. | +| `catalog_discount` - [`ProductDiscount`](#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | +| `original_item_price` - [`Money!`](#money) | The value of the original unit price for the item, including discounts. | +| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | +| `price` - [`Money!`](#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!`](#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`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | #### Example ```json { - "items": [AdminAssistanceAction], - "page_info": SearchResultPageInfo, - "total_count": 987 + "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 } ``` -### Aggregation +### CartItemSelectedOptionValuePrice -A bucket that contains information for each filterable option +Contains details about the price of a selected customizable value. #### Fields | Field Name | Description | |------------|-------------| -| `attribute` - [`String!`](#string) | The attribute code of the filter item | -| `buckets` - [`[Bucket]!`](#bucket) | A container that divides the data into manageable groups. For example, attributes that can have numeric values might have buckets that define price ranges | -| `title` - [`String!`](#string) | The filter name displayed in layered navigation | -| `type` - [`AggregationType`](#aggregationtype) | Identifies the data type of the aggregation | +| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | +| `units` - [`String!`](#string) | A string that describes the unit of the value. | +| `value` - [`Float!`](#float) | A price value. | #### Example ```json { - "attribute": "xyz789", - "buckets": [Bucket], - "title": "xyz789", - "type": "INTELLIGENT" + "type": "FIXED", + "units": "xyz789", + "value": 987.65 } ``` -### AggregationType +### CartItemUpdateInput -Identifies the data type of the aggregation +A single item to be updated. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `INTELLIGENT` | | -| `PINNED` | | -| `POPULAR` | | +| Input Field | Description | +|-------------|-------------| +| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | +| `quantity` - [`Float`](#float) | The new quantity of the item. | #### Example ```json -""INTELLIGENT"" +{ + "cart_item_uid": 4, + "customizable_options": [CustomizableOptionInput], + "gift_message": GiftMessageInput, + "gift_wrapping_id": "4", + "quantity": 123.45 +} ``` -### ApplePayConfig +### CartItems #### Fields | Field Name | Description | |------------|-------------| -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the ApplePay Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | +| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int!`](#int) | The number of returned cart items. | #### Example ```json { - "button_styles": ButtonStyles, - "code": "xyz789", - "is_visible": false, - "payment_intent": "abc123", - "payment_source": "abc123", - "sdk_params": [SDKParams], - "sort_order": "xyz789", - "title": "xyz789" + "items": [CartItemInterface], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### ApplePayMethodInput +### CartPrices -Apple Pay inputs +Contains details about the final price of items in the cart, including discount and tax information. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| Field Name | Description | +|------------|-------------| +| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | +| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | +| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | +| `grand_total_excluding_tax` - [`Money`](#money) | The total of the cart, including discounts, shipping, and other fees without tax. | +| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | +| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | +| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "applied_taxes": [CartTaxItem], + "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 } ``` -### AppliedCoupon - -Contains the applied coupon code. +### CartRuleStorefront #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | The coupon code the shopper applied to the card. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartRule` object. | #### Example ```json -{"code": "xyz789"} +{"uid": 4} ``` -### AppliedGiftCard +### CartTaxItem -Contains an applied gift card with applied and remaining balance. +Contains tax information about an item in the cart. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The amount applied to the current cart. | -| `code` - [`String`](#string) | The gift card account code. | -| `current_balance` - [`Money`](#money) | The remaining balance on the gift card. | -| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | +| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | +| `label` - [`String!`](#string) | The description of the tax. | #### Example ```json { - "applied_balance": Money, - "code": "xyz789", - "current_balance": Money, - "expiration_date": "xyz789" + "amount": Money, + "label": "xyz789" } ``` -### AppliedQueryRule - -The rule that was applied to this product +### CartUserInputError #### Fields | Field Name | Description | |------------|-------------| -| `action_type` - [`AppliedQueryRuleActionType`](#appliedqueryruleactiontype) | An enum that defines the type of rule that was applied | -| `rule_id` - [`String`](#string) | The ID assigned to the rule | -| `rule_name` - [`String`](#string) | The name of the applied rule | +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "action_type": "BOOST", - "rule_id": "abc123", - "rule_name": "xyz789" + "code": "PRODUCT_NOT_FOUND", + "message": "xyz789" } ``` -### AppliedQueryRuleActionType - -The type of rule that was applied to a product during search (optional) +### CartUserInputErrorType #### Values | Enum Value | Description | |------------|-------------| -| `BOOST` | | -| `BURY` | | -| `PIN` | | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `COULD_NOT_FIND_CART_ITEM` | | +| `REQUIRED_PARAMETER_MISSING` | | +| `INVALID_PARAMETER_VALUE` | | +| `UNDEFINED` | | +| `PERMISSION_DENIED` | | #### Example ```json -""BOOST"" +""PRODUCT_NOT_FOUND"" ``` -### AppliedStoreCredit - -Contains the applied and current balances. +### CatalogAttributeApplyToEnum -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `applied_balance` - [`Money`](#money) | The applied store credit balance to the current cart. | -| `current_balance` - [`Money`](#money) | The current balance remaining on store credit. | -| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the current balance will not be returned. | +| `SIMPLE` | | +| `VIRTUAL` | | +| `BUNDLE` | | +| `DOWNLOADABLE` | | +| `CONFIGURABLE` | | +| `GROUPED` | | +| `CATEGORY` | | #### Example ```json -{ - "applied_balance": Money, - "current_balance": Money, - "enabled": true -} +""SIMPLE"" ``` -### ApplyCouponToCartInput +### CatalogAttributeMetadata -Specifies the coupon code to apply to the cart. +Swatch attribute metadata. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_code` - [`String!`](#string) | A valid coupon code. | +| Field Name | Description | +|------------|-------------| +| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | +| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | +| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | +| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | +| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | +| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | +| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | +| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | +| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | +| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | +| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | #### Example ```json { - "cart_id": "xyz789", - "coupon_code": "abc123" + "apply_to": ["SIMPLE"], + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "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": false, + "is_used_for_price_rules": false, + "is_used_for_promo_rules": true, + "is_visible_in_advanced_search": false, + "is_visible_on_front": false, + "is_wysiwyg_enabled": false, + "label": "abc123", + "options": [CustomAttributeOptionInterface], + "swatch_input_type": "BOOLEAN", + "update_product_preview_image": false, + "use_product_image_for_swatch": true, + "used_in_product_listing": true } ``` -### ApplyCouponToCartOutput +### CategoryBucket -Contains details about the cart after applying a coupon. +New category bucket for federation #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after applying a coupon. | +| `count` - [`Int!`](#int) | | +| `id` - [`ID!`](#id) | | +| `path` - [`String!`](#string) | | +| `title` - [`String!`](#string) | | #### Example ```json -{"cart": Cart} +{ + "count": 123, + "id": 4, + "path": "xyz789", + "title": "abc123" +} ``` -### ApplyCouponsStrategy - -The strategy to apply coupons to the cart. +### CategoryBucketInterface -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `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. | +| `id` - [`ID!`](#id) | | + +#### Possible Types + +| CategoryBucketInterface Types | +|----------------| +| [`CategoryBucket`](#categorybucket) | #### Example ```json -""APPEND"" +{"id": "4"} ``` -### ApplyCouponsToCartInput +### CategoryInterface -Apply coupons to the cart. +Contains the full set of attributes that can be returned in a category search. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#string) | An array of valid coupon codes. | -| `type` - [`ApplyCouponsStrategy`](#applycouponsstrategy) | `replace` to replace the existing coupon(s) or `append` to add the coupon to the coupon(s) list. | +| Field Name | Description | +|------------|-------------| +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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`](#string) | | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | + +#### Possible Types + +| CategoryInterface Types | +|----------------| +| [`CategoryTree`](#categorytree) | #### Example ```json { - "cart_id": "abc123", - "coupon_codes": ["abc123"], - "type": "APPEND" + "available_sort_by": ["abc123"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "xyz789", + "children_count": "xyz789", + "custom_layout_update_file": "xyz789", + "default_sort_by": "xyz789", + "description": "xyz789", + "display_mode": "abc123", + "filter_price_range": 987.65, + "image": "abc123", + "include_in_menu": 123, + "is_anchor": 987, + "landing_page": 987, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "path": "abc123", + "path_in_store": "abc123", + "position": 123, + "product_count": 987, + "uid": "4", + "url_key": "xyz789", + "url_path": "xyz789" } ``` -### ApplyGiftCardToCartInput +### CategoryTree -Defines the input required to run the `applyGiftCardToCart` mutation. +Contains the hierarchy of categories. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be applied to the cart. | +| Field Name | Description | +|------------|-------------| +| `available_sort_by` - [`[String]`](#string) | | +| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | +| `canonical_url` - [`String`](#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`](#string) | | +| `custom_layout_update_file` - [`String`](#string) | | +| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | +| `description` - [`String`](#string) | An optional description of the category. | +| `display_mode` - [`String`](#string) | | +| `filter_price_range` - [`Float`](#float) | | +| `image` - [`String`](#string) | | +| `include_in_menu` - [`Int`](#int) | | +| `is_anchor` - [`Int`](#int) | | +| `landing_page` - [`Int`](#int) | | +| `level` - [`Int`](#int) | The depth of the category within the tree. | +| `meta_description` - [`String`](#string) | | +| `meta_keywords` - [`String`](#string) | | +| `meta_title` - [`String`](#string) | | +| `name` - [`String`](#string) | The display name of the category. | +| `path` - [`String`](#string) | The full category path. | +| `path_in_store` - [`String`](#string) | The category path within the store. | +| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | +| `product_count` - [`Int`](#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. | +| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | +| `url_key` - [`String`](#string) | The URL key assigned to the category. | +| `url_path` - [`String`](#string) | The URL path assigned to the category. | #### Example ```json { - "cart_id": "xyz789", - "gift_card_code": "abc123" + "available_sort_by": ["abc123"], + "breadcrumbs": [Breadcrumb], + "canonical_url": "abc123", + "children_count": "xyz789", + "custom_layout_update_file": "abc123", + "default_sort_by": "abc123", + "description": "abc123", + "display_mode": "abc123", + "filter_price_range": 123.45, + "image": "abc123", + "include_in_menu": 123, + "is_anchor": 123, + "landing_page": 123, + "level": 987, + "meta_description": "xyz789", + "meta_keywords": "xyz789", + "meta_title": "xyz789", + "name": "xyz789", + "path": "abc123", + "path_in_store": "abc123", + "position": 987, + "product_count": 987, + "uid": 4, + "url_key": "xyz789", + "url_path": "abc123" } ``` -### ApplyGiftCardToCartOutput +### CategoryView -Defines the possible output for the `applyGiftCardToCart` mutation. +Represents a category. Contains information about a category, including the category ID, the category name, the category path, the category URL key, the category URL path, and the category roles. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | Describes the contents of the specified shopping cart. | +| `availableSortBy` - [`[String]`](#string) | List of available sort by options. For example, `name`, `position` or `size`. | +| `children` - [`[String!]`](#string) | List of child category IDs. For example, `123`, `456` or `789`. | +| `defaultSortBy` - [`String`](#string) | Default sort by option. For example, `name`, `position` or `size`. | +| `id` - [`ID!`](#id) | Category ID. For example, `123`, `456` or `789`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | +| `level` - [`Int`](#int) | The level of the category. The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | +| `name` - [`String`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | +| `parentId` - [`String!`](#string) | Parent category ID. For example, `123`, `456` or `789`. | +| `position` - [`Int`](#int) | The position of the category in sort order. For example, `1`, `2`, `3` or `10`. | +| `path` - [`String`](#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | +| `roles` - [`[String!]!`](#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `urlKey` - [`String`](#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | +| `urlPath` - [`String`](#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `count` - [`Int!`](#int) | *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | +| `title` - [`String!`](#string) | *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | #### Example ```json -{"cart": Cart} +{ + "availableSortBy": ["xyz789"], + "children": ["xyz789"], + "defaultSortBy": "abc123", + "id": "4", + "level": 123, + "name": "xyz789", + "parentId": "xyz789", + "position": 123, + "path": "abc123", + "roles": ["abc123"], + "urlKey": "xyz789", + "urlPath": "abc123", + "count": 123, + "title": "xyz789" +} ``` -### ApplyGiftCardToOrder +### CategoryViewInterface -Contains applied gift cards with gift card code and amount. +Base interface defining essential category fields shared across all category views. #### Fields | Field Name | Description | |------------|-------------| -| `applied_balance` - [`Money!`](#money) | The gift card amount applied to the current order. | -| `code` - [`String!`](#string) | The gift card account code. | +| `availableSortBy` - [`[String]`](#string) | List of available sort by options. For example, name, size or position. | +| `defaultSortBy` - [`String`](#string) | Default sort by option. For example, name, size or position. | +| `id` - [`ID!`](#id) | Category ID. For example, `123`, `456` or `789`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | +| `level` - [`Int`](#int) | The level of the category. The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | +| `name` - [`String`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | +| `path` - [`String`](#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | +| `roles` - [`[String]`](#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | +| `urlKey` - [`String`](#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | +| `urlPath` - [`String`](#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | + +#### Possible Types + +| CategoryViewInterface Types | +|----------------| +| [`CategoryView`](#categoryview) | #### Example ```json { - "applied_balance": Money, - "code": "xyz789" + "availableSortBy": ["abc123"], + "defaultSortBy": "xyz789", + "id": "4", + "level": 123, + "name": "abc123", + "path": "abc123", + "roles": ["xyz789"], + "urlKey": "abc123", + "urlPath": "abc123" } ``` -### ApplyRewardPointsToCartOutput +### CheckoutAgreement -Contains the customer cart. +Defines details about an individual checkout agreement. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are applied. | +| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | +| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | +| `content` - [`String!`](#string) | Required. The text of the agreement. | +| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | +| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | +| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | +| `name` - [`String!`](#string) | The name given to the condition. | #### Example ```json -{"cart": Cart} -``` +{ + "agreement_id": 987, + "checkbox_text": "abc123", + "content": "xyz789", + "content_height": "abc123", + "is_html": true, + "mode": "AUTO", + "name": "xyz789" +} +``` -### ApplyStoreCreditToCartInput +### CheckoutAgreementMode -Defines the input required to run the `applyStoreCreditToCart` mutation. +Indicates how agreements are accepted. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| Enum Value | Description | +|------------|-------------| +| `AUTO` | Conditions are automatically accepted upon checkout. | +| `MANUAL` | Shoppers must manually accept the conditions to place an order. | #### Example ```json -{"cart_id": "abc123"} +""AUTO"" ``` -### ApplyStoreCreditToCartOutput +### CheckoutUserInputError -Defines the possible output for the `applyStoreCreditToCart` mutation. +An error encountered while adding an item to the cart. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | +| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | +| `message` - [`String!`](#string) | A localized error message. | +| `path` - [`[String]!`](#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 ```json -{"cart": Cart} +{ + "code": "REORDER_NOT_AVAILABLE", + "message": "xyz789", + "path": ["xyz789"] +} ``` -### AreaInput - -AreaInput defines the parameters which will be used for filter by specified location. +### CheckoutUserInputErrorCodes -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `radius` - [`Int!`](#int) | The radius for the search in KM. | -| `search_term` - [`String!`](#string) | The country code where search must be performed. Required parameter together with region, city or postcode. | +| Enum Value | Description | +|------------|-------------| +| `REORDER_NOT_AVAILABLE` | | +| `PRODUCT_NOT_FOUND` | | +| `NOT_SALABLE` | | +| `INSUFFICIENT_STOCK` | | +| `UNDEFINED` | | #### Example ```json -{"radius": 123, "search_term": "abc123"} +""REORDER_NOT_AVAILABLE"" ``` -### AssetImage +### ClearCustomerCartOutput -Contains information about an asset image. +Output of the request to clear the customer cart. #### Fields | Field Name | Description | |------------|-------------| -| `asset_image` - [`ProductMediaGalleryEntriesAssetImage`](#productmediagalleryentriesassetimage) | Contains a `ProductMediaGalleryEntriesAssetImage` object. | -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | +| `cart` - [`Cart`](#cart) | The cart after clearing items. | +| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | #### Example ```json -{ - "asset_image": ProductMediaGalleryEntriesAssetImage, - "disabled": false, - "label": "xyz789", - "position": 123, - "url": "xyz789" -} +{"cart": Cart, "status": false} +``` + + + +### CloseNegotiableQuoteError + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | + +#### Example + +```json +NegotiableQuoteInvalidStateError ``` -### AssetVideo +### CloseNegotiableQuoteOperationFailure -Contains information about an asset video. +Contains details about a failed close operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `asset_video` - [`ProductMediaGalleryEntriesAssetVideo`](#productmediagalleryentriesassetvideo) | Contains a `ProductMediaGalleryEntriesAssetVideo` object. | -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | +| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "asset_video": ProductMediaGalleryEntriesAssetVideo, - "disabled": false, - "label": "abc123", - "position": 987, - "url": "abc123" + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": 4 } ``` -### AssignChildCompanyInput +### CloseNegotiableQuoteOperationResult + +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | + +#### Example + +```json +NegotiableQuoteUidOperationSuccess +``` + + + +### CloseNegotiableQuotesInput -Defines the input schema for assigning a child company to a parent company. +Defines the negotiable quotes to mark as closed. #### Input Fields | Input Field | Description | |-------------|-------------| -| `child_company_id` - [`ID!`](#id) | The unique ID of the child company. | -| `parent_company_id` - [`ID!`](#id) | The unique ID of the parent company. | +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | #### Example ```json -{ - "child_company_id": "4", - "parent_company_id": 4 -} +{"quote_uids": [4]} ``` -### AssignChildCompanyOutput +### CloseNegotiableQuotesOutput -Contains the response to the request to assign a child company. +Contains the closed negotiable quotes and other negotiable quotes the company user can view. #### Fields | Field Name | Description | |------------|-------------| -| `company_hierarchy` - [`CompanyHierarchy!`](#companyhierarchy) | The updated company hierarchy for the parent company. | +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | +| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | #### Example ```json -{"company_hierarchy": CompanyHierarchy} +{ + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" +} ``` -### AssignCompareListToCustomerOutput - -Contains the results of the request to assign a compare list. +### ColorSwatchData #### Fields | Field Name | Description | |------------|-------------| -| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | -| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully assigned to the customer. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | #### Example ```json -{"compare_list": CompareList, "result": true} +{"value": "xyz789"} ``` -### AttributeEntityTypeEnum +### CommerceOptimizerContext -List of all entity types. Populated by the modules introducing EAV entities. +Commerce Optimizer entities -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `CATALOG_PRODUCT` | | -| `CATALOG_CATEGORY` | | -| `CUSTOMER` | | -| `CUSTOMER_ADDRESS` | | -| `RMA_ITEM` | | +| `priceBookId` - [`ID!`](#id) | The priceBookId for current customer session. | #### Example ```json -""CATALOG_PRODUCT"" +{"priceBookId": "4"} ``` -### AttributeFile +### CompaniesSortFieldEnum -#### Fields +The fields available for sorting the customer companies. -| Field Name | Description | +#### Values + +| Enum Value | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | -| `url` - [`String!`](#string) | File URL to download the file. | -| `value` - [`String!`](#string) | File code. For file download use `url` field. | +| `NAME` | The name of the company. | #### Example ```json -{ - "attribute_type": "abc123", - "code": "4", - "url": "abc123", - "value": "abc123" -} +""NAME"" ``` -### AttributeFilterInput +### CompaniesSortInput -An input object that specifies the filters used for attributes. +Specifies which field to sort on, and whether to return the results in ascending or descending order. #### Input Fields | Input Field | Description | |-------------|-------------| -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_used_for_customer_segment` - [`Boolean`](#boolean) | Whether a customer or customer address attribute is used for customer segment or not. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | +| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | +| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | #### Example ```json -{ - "is_comparable": false, - "is_filterable": true, - "is_filterable_in_search": false, - "is_html_allowed_on_front": true, - "is_searchable": true, - "is_used_for_customer_segment": false, - "is_used_for_price_rules": false, - "is_used_for_promo_rules": false, - "is_visible_in_advanced_search": false, - "is_visible_on_front": false, - "is_wysiwyg_enabled": false, - "used_in_product_listing": false -} +{"field": "NAME", "order": "ASC"} ``` -### AttributeFrontendInputEnum +### Company -EAV attribute frontend input types. +Contains the output schema for a company. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `WEIGHT` | | -| `UNDEFINED` | | +| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | Available payment methods for the company with proper B2B configuration and company-specific filtering. | +| `available_shipping_methods` - [`[CompanyAvailableShippingMethod]`](#companyavailableshippingmethod) | Available shipping carriers for the company with proper B2B configuration and company-specific filtering. | +| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | +| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | +| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the company | +| `email` - [`String`](#string) | The email address of the company contact. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | +| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | +| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | +| `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | +| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | +| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | +| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | +| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json -""BOOLEAN"" +{ + "acl_resources": [CompanyAclResource], + "available_payment_methods": [AvailablePaymentMethod], + "available_shipping_methods": [ + CompanyAvailableShippingMethod + ], + "company_admin": Customer, + "credit": CompanyCredit, + "credit_history": CompanyCreditHistory, + "custom_attributes": [CustomAttribute], + "email": "xyz789", + "id": "4", + "legal_address": CompanyLegalAddress, + "legal_name": "xyz789", + "name": "abc123", + "payment_methods": ["abc123"], + "reseller_id": "abc123", + "role": CompanyRole, + "roles": CompanyRoles, + "sales_representative": CompanySalesRepresentative, + "status": "PENDING", + "structure": CompanyStructure, + "team": CompanyTeam, + "user": Customer, + "users": CompanyUsers, + "vat_tax_id": "abc123" +} ``` -### AttributeImage +### CompanyAclResource + +Contains details about the access control list settings of a resource. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | -| `url` - [`String!`](#string) | Image URL to download the image. | -| `value` - [`String!`](#string) | Image code. For image download use `url` field. | +| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | +| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | +| `text` - [`String`](#string) | The label assigned to the ACL resource. | #### Example ```json { - "attribute_type": "abc123", - "code": 4, - "url": "xyz789", - "value": "abc123" + "children": [CompanyAclResource], + "id": 4, + "sort_order": 987, + "text": "abc123" } ``` -### AttributeInput +### CompanyAdminInput -Defines the attribute characteristics to search for the `attribute_code` and `entity_type` to search. +Defines the input schema for creating a company administrator. #### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `entity_type` - [`String`](#string) | The type of entity that defines the attribute. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The company administrator's custom attributes. | +| `email` - [`String!`](#string) | The email address of the company administrator. | +| `firstname` - [`String!`](#string) | The company administrator's first name. | +| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | +| `job_title` - [`String`](#string) | The job title of the company administrator. | +| `lastname` - [`String!`](#string) | The company administrator's last name. | +| `telephone` - [`String`](#string) | The phone number of the company administrator. | #### Example ```json { - "attribute_code": "xyz789", - "entity_type": "xyz789" + "custom_attributes": [AttributeValueInput], + "email": "abc123", + "firstname": "abc123", + "gender": 123, + "job_title": "abc123", + "lastname": "xyz789", + "telephone": "abc123" } ``` -### AttributeInputSelectedOption +### CompanyAvailableShippingMethod -Specifies selected option for a select or multiselect attribute value. +Describes a carrier-level shipping option available to the company. -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `value` - [`String!`](#string) | The attribute option value. | - -#### Example - -```json -{"value": "xyz789"} -``` - - - -### AttributeMetadata - -Base EAV implementation of CustomAttributeMetadataInterface. - -#### Fields +#### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `code` - [`String!`](#string) | | +| `title` - [`String!`](#string) | | #### Example ```json { - "code": "4", - "default_value": "xyz789", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": true, - "label": "xyz789", - "options": [CustomAttributeOptionInterface] + "code": "abc123", + "title": "abc123" } ``` -### AttributeMetadataError +### CompanyBasicInfo -Attribute metadata retrieval error. +The minimal required information to identify and display the company. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | Attribute metadata retrieval error message. | -| `type` - [`AttributeMetadataErrorType!`](#attributemetadataerrortype) | Attribute metadata retrieval error type. | +| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `is_admin` - [`Boolean!`](#boolean) | Indicates whether the company is the admin (parent) company in the returned relation hierarchy. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `name` - [`String`](#string) | The name of the company. | +| `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | #### Example ```json { - "message": "xyz789", - "type": "ENTITY_NOT_FOUND" + "id": 4, + "is_admin": false, + "legal_name": "abc123", + "name": "xyz789", + "status": "PENDING" } ``` -### AttributeMetadataErrorType - -Attribute metadata retrieval error types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 - -```json -""ENTITY_NOT_FOUND"" -``` - - - -### AttributeMetadataResponse +### CompanyCreateInput -Contains the output of the `attributeMetadata` query +Defines the input schema for creating a new company. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `filterableInSearch` - [`[FilterableInSearchAttribute!]`](#filterableinsearchattribute) | An array of product attributes that can be used for filtering in a `productSearch` query | -| `sortable` - [`[SortableAttribute!]`](#sortableattribute) | An array of product attributes that can be used for sorting in a `productSearch` query | +| Input Field | Description | +|-------------|-------------| +| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | +| `company_email` - [`String!`](#string) | The email address of the company contact. | +| `company_name` - [`String!`](#string) | The name of the company to create. | +| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "filterableInSearch": [FilterableInSearchAttribute], - "sortable": [SortableAttribute] + "company_admin": CompanyAdminInput, + "company_email": "xyz789", + "company_name": "abc123", + "legal_address": CompanyLegalAddressCreateInput, + "legal_name": "abc123", + "reseller_id": "abc123", + "vat_tax_id": "abc123" } ``` -### AttributeOptionMetadata +### CompanyCredit -Base EAV implementation of CustomAttributeOptionInterface. +Contains company credit balances and limits. #### Fields | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | +| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | +| `exceed_limit` - [`Boolean!`](#boolean) | Indicates whether company credit functionality is allowed to exceed current company credit limit. | +| `outstanding_balance` - [`Money!`](#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 ```json { - "is_default": true, - "label": "xyz789", - "value": "xyz789" + "available_credit": Money, + "credit_limit": Money, + "exceed_limit": false, + "outstanding_balance": Money } ``` -### AttributeSelectedOption +### CompanyCreditHistory + +Contains details about prior company credit operations. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | #### Example ```json { - "label": "abc123", - "value": "xyz789" + "items": [CompanyCreditOperation], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### AttributeSelectedOptionInterface - -#### Fields +### CompanyCreditHistoryFilterInput -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The attribute selected option label. | -| `value` - [`String!`](#string) | The attribute selected option value. | +Defines a filter for narrowing the results of a credit history search. -#### Possible Types +#### Input Fields -| AttributeSelectedOptionInterface Types | -|----------------| -| [`AttributeSelectedOption`](#attributeselectedoption) | +| Input Field | Description | +|-------------|-------------| +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | #### Example ```json { - "label": "xyz789", - "value": "abc123" + "custom_reference_number": "xyz789", + "operation_type": "ALLOCATION", + "updated_by": "xyz789" } ``` -### AttributeSelectedOptions +### CompanyCreditOperation + +Contains details about a single company credit operation. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | -| `selected_options` - [`[AttributeSelectedOptionInterface]!`](#attributeselectedoptioninterface) | | +| `amount` - [`Money`](#money) | The amount of the company credit operation. | +| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | +| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | +| `date` - [`String!`](#string) | The date the operation occurred. | +| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | +| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | #### Example ```json { - "attribute_type": "abc123", - "code": 4, - "selected_options": [AttributeSelectedOptionInterface] + "amount": Money, + "balance": CompanyCredit, + "custom_reference_number": "xyz789", + "date": "abc123", + "type": "ALLOCATION", + "updated_by": CompanyCreditOperationUser } ``` -### AttributeValue +### CompanyCreditOperationType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | -| `value` - [`String!`](#string) | The attribute value. | +| `ALLOCATION` | | +| `UPDATE` | | +| `PURCHASE` | | +| `REIMBURSEMENT` | | +| `REFUND` | | +| `REVERT` | | #### Example ```json -{ - "attribute_type": "abc123", - "code": 4, - "value": "abc123" -} +""ALLOCATION"" ``` -### AttributeValueInput +### CompanyCreditOperationUser -Specifies the value for attribute. +Defines the administrator or company user that submitted a company credit operation. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | The code of the attribute. | -| `selected_options` - [`[AttributeInputSelectedOption]`](#attributeinputselectedoption) | An array containing selected options for a select or multiselect attribute. | -| `value` - [`String`](#string) | The value assigned to the attribute. | +| Field Name | Description | +|------------|-------------| +| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | +| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | #### Example ```json -{ - "attribute_code": "abc123", - "selected_options": [AttributeInputSelectedOption], - "value": "abc123" -} +{"name": "abc123", "type": "CUSTOMER"} ``` -### AttributeValueInterface +### CompanyCreditOperationUserType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | - -#### Possible Types - -| AttributeValueInterface Types | -|----------------| -| [`AttributeFile`](#attributefile) | -| [`AttributeImage`](#attributeimage) | -| [`AttributeSelectedOptions`](#attributeselectedoptions) | -| [`AttributeValue`](#attributevalue) | -| [`ProductAttributeFile`](#productattributefile) | +| `CUSTOMER` | | +| `ADMIN` | | #### Example ```json -{"attribute_type": "xyz789", "code": 4} +""CUSTOMER"" ``` -### AttributesFormOutput +### CompanyHierarchy -Metadata of EAV attributes associated to form +Defines a parent company and its direct child companies. #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| `children` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of direct child companies. | +| `parent` - [`CompanyBasicInfo`](#companybasicinfo) | The parent company in the relation hierarchy. Null if the company has no parent. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] + "children": [CompanyBasicInfo], + "parent": CompanyBasicInfo } ``` -### AttributesMetadataOutput +### CompanyInvitationInput -Metadata of EAV attributes. +Defines the input schema for accepting the company invitation. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors of retrieving certain attributes metadata. | -| `items` - [`[CustomAttributeMetadataInterface]!`](#customattributemetadatainterface) | Requested attributes metadata. | +| Input Field | Description | +|-------------|-------------| +| `code` - [`String!`](#string) | The invitation code. | +| `role_id` - [`ID`](#id) | The company role id. | +| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [CustomAttributeMetadataInterface] + "code": "xyz789", + "role_id": 4, + "user": CompanyInvitationUserInput } ``` -### AvailableCurrency +### CompanyInvitationOutput -Defines the code and symbol of a currency that can be used for purchase orders. +The result of accepting the company invitation. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CurrencyEnum!`](#currencyenum) | 3-letter currency code, for example USD. | -| `symbol` - [`String!`](#string) | Currency symbol, for example $. | +| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{"success": false} ``` -### AvailablePaymentMethod +### CompanyInvitationUserInput -Describes a payment method that the shopper can use to pay for the order. +Company user attributes in the invitation. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `is_deferred` - [`Boolean!`](#boolean) | If the payment method is an online integration | -| `oope_payment_method_config` - [`OopePaymentMethodConfig`](#oopepaymentmethodconfig) | Configuration for out of process payment methods | -| `title` - [`String!`](#string) | The payment method title. | +| Input Field | Description | +|-------------|-------------| +| `company_id` - [`ID!`](#id) | The company unique identifier. | +| `customer_id` - [`ID!`](#id) | The customer unique identifier. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The phone number of the company user. | #### Example ```json { - "code": "xyz789", - "is_deferred": true, - "oope_payment_method_config": OopePaymentMethodConfig, - "title": "xyz789" + "company_id": "4", + "customer_id": "4", + "job_title": "abc123", + "status": "ACTIVE", + "telephone": "abc123" } ``` -### AvailableShippingMethod +### CompanyLegalAddress -Contains details about the possible shipping methods and carriers. +Contains details about the address where the company is registered to conduct business. #### Fields | Field Name | Description | |------------|-------------| -| `additional_data` - [`[ShippingAdditionalData]`](#shippingadditionaldata) | Additional data related to the shipping method. | -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `available` - [`Boolean!`](#boolean) | Indicates whether this shipping method can be applied to the cart. | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `error_message` - [`String`](#string) | Describes an error condition. | -| `method_code` - [`String`](#string) | A shipping method code associated with a carrier. The value could be null if no method is available. | -| `method_title` - [`String`](#string) | The label for the shipping method code. The value could be null if no method is available. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | +| `postcode` - [`String`](#string) | The company's postal code. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | +| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | +| `telephone` - [`String`](#string) | The company's phone number. | #### Example ```json { - "additional_data": [ShippingAdditionalData], - "amount": Money, - "available": false, - "carrier_code": "abc123", - "carrier_title": "abc123", - "error_message": "abc123", - "method_code": "abc123", - "method_title": "abc123", - "price_excl_tax": Money, - "price_incl_tax": Money + "city": "xyz789", + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegion, + "street": ["xyz789"], + "telephone": "xyz789" } ``` -### BatchMutationStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SUCCESS` | | -| `FAILURE` | | -| `MIXED_RESULTS` | | - -#### Example - -```json -""SUCCESS"" -``` - - - -### BillingAddressInput +### CompanyLegalAddressCreateInput -Defines the billing address. +Defines the input schema for defining a company's legal address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a billing address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for billing. | -| `same_as_shipping` - [`Boolean`](#boolean) | Indicates whether to set the billing address to be the same as the existing shipping address on the cart. | -| `use_for_shipping` - [`Boolean`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | +| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | +| `postcode` - [`String!`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String!`](#string) | The primary phone number of the company. | #### Example ```json { - "address": CartAddressInput, - "customer_address_id": 123, - "customer_address_uid": 4, - "same_as_shipping": false, - "use_for_shipping": false + "city": "abc123", + "country_id": "AF", + "postcode": "abc123", + "region": CustomerAddressRegionInput, + "street": ["xyz789"], + "telephone": "xyz789" } ``` -### BillingAddressPaymentSourceInput +### CompanyLegalAddressUpdateInput -The billing address information +Defines the input schema for updating a company's legal address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `address_line_1` - [`String`](#string) | The first line of the address | -| `address_line_2` - [`String`](#string) | The second line of the address | -| `city` - [`String`](#string) | The city of the address | -| `country_code` - [`String!`](#string) | The country of the address | -| `postal_code` - [`String`](#string) | The postal code of the address | -| `region` - [`String`](#string) | The region of the address | +| `city` - [`String`](#string) | The city where the company is registered to conduct business. | +| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | +| `postcode` - [`String`](#string) | The postal code of the company. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | +| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | +| `telephone` - [`String`](#string) | The primary phone number of the company. | #### Example ```json { - "address_line_1": "abc123", - "address_line_2": "abc123", "city": "abc123", - "country_code": "xyz789", - "postal_code": "abc123", - "region": "abc123" + "country_id": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["xyz789"], + "telephone": "abc123" } ``` -### BillingCartAddress +### CompanyRole -Contains details about the billing address. +Contails details about a single role. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name assigned to the role. | +| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | +| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | #### Example ```json { - "city": "xyz789", - "company": "abc123", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "fax": "abc123", - "firstname": "xyz789", - "id": 123, - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", - "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "id": "4", + "name": "abc123", + "permissions": [CompanyAclResource], + "users_count": 123 } ``` -### Boolean +### CompanyRoleCreateInput + +Defines the input schema for creating a company role. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the role to create. | +| `permissions` - [`[String]`](#string) | A list of resources the role can access. | + +#### Example -The `Boolean` scalar type represents `true` or `false`. +```json +{ + "name": "xyz789", + "permissions": ["abc123"] +} +``` -### Breadcrumb +### CompanyRoleUpdateInput -Contains details about an individual category that comprises a breadcrumb. +Defines the input schema for updating a company role. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `category_level` - [`Int`](#int) | The category level. | -| `category_name` - [`String`](#string) | The display name of the category. | -| `category_uid` - [`ID!`](#id) | The unique ID for a `Breadcrumb` object. | -| `category_url_key` - [`String`](#string) | The URL key of the category. | -| `category_url_path` - [`String`](#string) | The URL path of the category. | +| Input Field | Description | +|-------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `name` - [`String`](#string) | The name of the role to update. | +| `permissions` - [`[String]`](#string) | A list of resources the role can access. | #### Example ```json { - "category_level": 123, - "category_name": "xyz789", - "category_uid": 4, - "category_url_key": "abc123", - "category_url_path": "abc123" + "id": "4", + "name": "xyz789", + "permissions": ["xyz789"] } ``` -### Bucket +### CompanyRoles -An interface for bucket contents +Contains an array of roles. #### Fields | Field Name | Description | |------------|-------------| -| `title` - [`String!`](#string) | A human-readable name of a bucket | - -#### Possible Types - -| Bucket Types | -|----------------| -| [`CategoryBucket`](#categorybucket) | -| [`CategoryView`](#categoryview) | -| [`RangeBucket`](#rangebucket) | -| [`ScalarBucket`](#scalarbucket) | -| [`StatsBucket`](#statsbucket) | +| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | #### Example ```json -{"title": "xyz789"} +{ + "items": [CompanyRole], + "page_info": SearchResultPageInfo, + "total_count": 987 +} ``` -### BundleCartItem +### CompanySalesRepresentative -An implementation for bundle product cart items. +Contains details about a company sales representative. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | -| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `email` - [`String`](#string) | The email address of the company sales representative. | +| `firstname` - [`String`](#string) | The company sales representative's first name. | +| `lastname` - [`String`](#string) | The company sales representative's last name. | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", - "bundle_options": [SelectedBundleOption], - "custom_attributes": [CustomAttribute], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "is_available": true, - "is_salable": false, - "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": 123.45, - "uid": "4" + "email": "abc123", + "firstname": "xyz789", + "lastname": "abc123" } ``` -### BundleCreditMemoItem +### CompanyStatusEnum -Defines bundle product options for `CreditMemoItemInterface`. +Defines the list of company status values. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a bundle product that is part of a credit memo. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `PENDING` | Company is pending approval. | +| `APPROVED` | Company is approved. | +| `REJECTED` | Company is rejected. | +| `BLOCKED` | Company is blocked. | #### Example ```json -{ - "bundle_options": [ItemSelectedBundleOption], - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_refunded": 987.65 -} +""PENDING"" ``` -### BundleInvoiceItem +### CompanyStructure -Defines bundle product options for `InvoiceItemInterface`. +Contains an array of the individual nodes that comprise the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to an invoiced bundle product. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | -| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | #### Example ```json -{ - "bundle_options": [ItemSelectedBundleOption], - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "id": "4", - "order_item": OrderItemInterface, - "product_name": "abc123", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_invoiced": 123.45 -} +{"items": [CompanyStructureItem]} ``` -### BundleItem - -Defines an individual item within a bundle product. +### CompanyStructureEntity -#### Fields +#### Types -| Field Name | Description | -|------------|-------------| -| `options` - [`[BundleItemOption]`](#bundleitemoption) | An array of additional options for this bundle item. | -| `position` - [`Int`](#int) | A number indicating the sequence order of this item compared to the other bundle items. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `required` - [`Boolean`](#boolean) | Indicates whether the item must be included in the bundle. | -| `sku` - [`String`](#string) | The SKU of the bundle product. | -| `title` - [`String`](#string) | The display name of the item. | -| `type` - [`String`](#string) | The input type that the customer uses to select the item. Examples include radio button and checkbox. | -| `uid` - [`ID`](#id) | The unique ID for a `BundleItem` object. | +| Union Types | +|-------------| +| [`CompanyTeam`](#companyteam) | +| [`Customer`](#customer) | #### Example ```json -{ - "options": [BundleItemOption], - "position": 123, - "price_range": PriceRange, - "required": false, - "sku": "xyz789", - "title": "xyz789", - "type": "abc123", - "uid": "4" -} +CompanyTeam ``` -### BundleItemOption +### CompanyStructureItem -Defines the characteristics that comprise a specific bundle item and its options. +Defines an individual node in the company structure. #### Fields | Field Name | Description | |------------|-------------| -| `can_change_quantity` - [`Boolean`](#boolean) | Indicates whether the customer can change the number of items for this option. | -| `is_default` - [`Boolean`](#boolean) | Indicates whether this option is the default option. | -| `label` - [`String`](#string) | The text that identifies the bundled item option. | -| `position` - [`Int`](#int) | When a bundle item contains multiple options, the relative position of this option compared to the other options. | -| `price` - [`Float`](#float) | The price of the selected option. | -| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | One of FIXED, PERCENT, or DYNAMIC. | -| `product` - [`ProductInterface`](#productinterface) | Contains details about this product option. | -| `quantity` - [`Float`](#float) | The quantity of this specific bundle item. | -| `uid` - [`ID!`](#id) | The unique ID for a `BundleItemOption` object. | +| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | +| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | +| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | #### Example ```json { - "can_change_quantity": true, - "is_default": true, - "label": "abc123", - "position": 123, - "price": 987.65, - "price_type": "FIXED", - "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "entity": CompanyTeam, + "id": "4", + "parent_id": "4" } ``` -### BundleOrderItem +### CompanyStructureUpdateInput -Defines bundle product options for `OrderItemInterface`. +Defines the input schema for updating the company structure. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to the bundle product. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| Input Field | Description | +|-------------|-------------| +| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | +| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], - "custom_attributes": [CustomAttribute], - "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": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "abc123" + "parent_tree_id": "4", + "tree_id": "4" } ``` -### BundleProduct +### CompanyTeam -Defines basic features of a bundle product and contains multiple BundleItems. +Describes a company team. #### Fields | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `dynamic_price` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic price. | -| `dynamic_sku` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamic SKU. | -| `dynamic_weight` - [`Boolean`](#boolean) | Indicates whether the bundle product has a dynamically calculated weight. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `items` - [`[BundleItem]`](#bundleitem) | An array containing information about individual bundle items. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_details` - [`PriceDetails`](#pricedetails) | The price details of the main product | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `price_view` - [`PriceViewEnum`](#priceviewenum) | One of PRICE_RANGE or AS_LOW_AS. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `ship_bundle_items` - [`ShipBundleItemsEnum`](#shipbundleitemsenum) | Indicates whether to ship bundle items together or individually. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID`](#id) | The unique ID for a `CompanyTeam` object. | +| `name` - [`String`](#string) | The display name of the team. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | #### Example ```json { - "canonical_url": "abc123", - "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "dynamic_price": true, - "dynamic_sku": true, - "dynamic_weight": true, - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "image": ProductImage, - "is_returnable": "abc123", - "items": [BundleItem], - "manufacturer": 123, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 123.45, + "description": "xyz789", + "id": "4", "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "price_details": PriceDetails, - "price_range": PriceRange, - "price_tiers": [TierPrice], - "price_view": "PRICE_RANGE", - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "related_products": [ProductInterface], - "ship_bundle_items": "TOGETHER", - "short_description": ComplexTextValue, - "sku": "xyz789", - "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "uid": 4, - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "weight": 123.45 + "structure_id": "4" } ``` -### BundleRequisitionListItem +### CompanyTeamCreateInput -Contains details about bundle products added to a requisition list. +Defines the input schema for creating a company team. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array of selected options for a bundle product. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `name` - [`String!`](#string) | The display name of the team. | +| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | #### Example ```json { - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 987.65, - "sku": "xyz789", - "uid": 4 + "description": "abc123", + "name": "xyz789", + "target_id": 4 } ``` -### BundleShipmentItem +### CompanyTeamUpdateInput -Defines bundle product options for `ShipmentItemInterface`. +Defines the input schema for updating a company team. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `bundle_options` - [`[ItemSelectedBundleOption]`](#itemselectedbundleoption) | A list of bundle options that are assigned to a shipped product. | -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the team. | +| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | +| `name` - [`String`](#string) | The display name of the team. | #### Example ```json { - "bundle_options": [ItemSelectedBundleOption], + "description": "abc123", "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 123.45 + "name": "abc123" } ``` -### BundleWishlistItem - -Defines bundle product options for `WishlistItemInterface`. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `bundle_options` - [`[SelectedBundleOption]`](#selectedbundleoption) | An array containing information about the selected bundle items. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | - -#### Example - -```json -{ - "added_at": "abc123", - "bundle_options": [SelectedBundleOption], - "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", - "product": ProductInterface, - "quantity": 987.65 -} -``` - - +### CompanyUpdateInput -### ButtonStyles +Defines the input schema for updating a company. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `color` - [`String`](#string) | The button color | -| `height` - [`Int`](#int) | The button height in pixels | -| `label` - [`String`](#string) | The button label | -| `layout` - [`String`](#string) | The button layout | -| `shape` - [`String`](#string) | The button shape | -| `tagline` - [`Boolean`](#boolean) | Indicates whether the tagline is displayed | -| `use_default_height` - [`Boolean`](#boolean) | Defines if the button uses default height. If the value is false, the value of height is used | +| Input Field | Description | +|-------------|-------------| +| `company_email` - [`String`](#string) | The email address of the company contact. | +| `company_name` - [`String`](#string) | The name of the company to update. | +| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | +| `legal_name` - [`String`](#string) | The full legal name of the company. | +| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | +| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | #### Example ```json { - "color": "abc123", - "height": 123, - "label": "abc123", - "layout": "xyz789", - "shape": "xyz789", - "tagline": false, - "use_default_height": true + "company_email": "abc123", + "company_name": "abc123", + "legal_address": CompanyLegalAddressUpdateInput, + "legal_name": "xyz789", + "reseller_id": "abc123", + "vat_tax_id": "xyz789" } ``` -### CancelNegotiableQuoteTemplateInput +### CompanyUserCreateInput -Specifies the quote template id of the quote template to cancel +Defines the input schema for creating a company user. #### Input Fields | Input Field | Description | |-------------|-------------| -| `cancellation_comment` - [`String`](#string) | A comment to provide reason of cancellation. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `email` - [`String!`](#string) | The company user's email address | +| `firstname` - [`String!`](#string) | The company user's first name. | +| `job_title` - [`String!`](#string) | The company user's job title or function. | +| `lastname` - [`String!`](#string) | The company user's last name. | +| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `target_id` - [`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!`](#string) | The company user's phone number. | #### Example ```json { - "cancellation_comment": "abc123", - "template_id": 4 + "email": "abc123", + "firstname": "xyz789", + "job_title": "xyz789", + "lastname": "xyz789", + "role_id": "4", + "status": "ACTIVE", + "target_id": "4", + "telephone": "xyz789" } ``` -### CancelOrderError +### CompanyUserStatusEnum -#### Fields +Defines the list of company user status values. -| Field Name | Description | +#### Values + +| Enum Value | Description | |------------|-------------| -| `code` - [`CancelOrderErrorCode!`](#cancelordererrorcode) | An error code that is specific to cancel order. | -| `message` - [`String!`](#string) | A localized error message. | +| `ACTIVE` | Only active users. | +| `INACTIVE` | Only inactive users. | #### Example ```json -{ - "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" -} +""ACTIVE"" ``` -### CancelOrderErrorCode +### CompanyUserUpdateInput -#### Values +Defines the input schema for updating a company user. -| Enum Value | Description | -|------------|-------------| -| `ORDER_CANCELLATION_DISABLED` | | -| `UNDEFINED` | | -| `UNAUTHORISED` | | -| `ORDER_NOT_FOUND` | | -| `PARTIAL_ORDER_ITEM_SHIPPED` | | -| `INVALID_ORDER_STATUS` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String`](#string) | The company user's email address. | +| `firstname` - [`String`](#string) | The company user's first name. | +| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | +| `job_title` - [`String`](#string) | The company user's job title or function. | +| `lastname` - [`String`](#string) | The company user's last name. | +| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `telephone` - [`String`](#string) | The company user's phone number. | #### Example ```json -""ORDER_CANCELLATION_DISABLED"" +{ + "email": "xyz789", + "firstname": "xyz789", + "id": "4", + "job_title": "abc123", + "lastname": "abc123", + "role_id": "4", + "status": "ACTIVE", + "telephone": "xyz789" +} ``` -### CancelOrderInput +### CompanyUsers -Defines the order to cancel. +Contains details about company users. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | -| `reason` - [`String!`](#string) | Cancellation reason. | +| Field Name | Description | +|------------|-------------| +| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int!`](#int) | The number of objects returned. | #### Example ```json -{"order_id": 4, "reason": "abc123"} +{ + "items": [Customer], + "page_info": SearchResultPageInfo, + "total_count": 987 +} ``` -### CancelOrderOutput +### CompanyUsersFilterInput -Contains the updated customer order and error message if any. +Defines the filter for returning a list of company users. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `error` - [`String`](#string) | Error encountered while cancelling the order. | -| `errorV2` - [`CancelOrderError`](#cancelordererror) | | -| `order` - [`CustomerOrder`](#customerorder) | Updated customer order. | +| Input Field | Description | +|-------------|-------------| +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | #### Example ```json -{ - "error": "xyz789", - "errorV2": CancelOrderError, - "order": CustomerOrder -} +{"status": "ACTIVE"} ``` -### CancellationReason +### ComparableAttribute + +Contains an attribute code that is used for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String!`](#string) | | +| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | +| `label` - [`String!`](#string) | The label of the attribute code. | #### Example ```json -{"description": "abc123"} +{ + "code": "abc123", + "label": "abc123" +} ``` -### Card +### ComparableItem + +Defines an object used to iterate through items for product comparisons. #### Fields | Field Name | Description | |------------|-------------| -| `bin_details` - [`CardBin`](#cardbin) | Card bin details | -| `card_expiry_month` - [`String`](#string) | Expiration month of the card | -| `card_expiry_year` - [`String`](#string) | Expiration year of the card | -| `last_digits` - [`String`](#string) | Last four digits of the card | -| `name` - [`String`](#string) | Name on the card | +| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | #### Example ```json { - "bin_details": CardBin, - "card_expiry_month": "abc123", - "card_expiry_year": "xyz789", - "last_digits": "xyz789", - "name": "xyz789" + "attributes": [ProductAttribute], + "product": ProductInterface, + "uid": "4" } ``` -### CardBin +### CompareList + +Contains iterable information such as the array of items, the count, and attributes that represent the compare list. #### Fields | Field Name | Description | |------------|-------------| -| `bin` - [`String`](#string) | Card bin number | +| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | +| `item_count` - [`Int!`](#int) | The number of items in the compare list. | +| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | #### Example ```json -{"bin": "xyz789"} +{ + "attributes": [ComparableAttribute], + "item_count": 123, + "items": [ComparableItem], + "uid": "4" +} ``` -### CardPaymentSourceInput +### CompleteOrderInput -The card payment source information +Update the quote and complete the order #### Input Fields | Input Field | Description | |-------------|-------------| -| `billing_address` - [`BillingAddressPaymentSourceInput!`](#billingaddresspaymentsourceinput) | The billing address of the card | -| `name` - [`String`](#string) | The name on the cardholder | +| `cartId` - [`String!`](#string) | The customer cart ID | +| `id` - [`String!`](#string) | PayPal order ID | #### Example ```json { - "billing_address": BillingAddressPaymentSourceInput, - "name": "abc123" + "cartId": "abc123", + "id": "abc123" } ``` -### CardPaymentSourceOutput +### ComplexProductView -The card payment source information +Represents all product types, except simple products. Complex product prices are returned as a price range, because price values can vary based on selected options. #### Fields | Field Name | Description | |------------|-------------| -| `brand` - [`String`](#string) | The brand of the card | -| `expiry` - [`String`](#string) | The expiry of the card | -| `last_digits` - [`String`](#string) | The last digits of the card | +| `addToCartAllowed` - [`Boolean`](#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the Only X Left threshold. *(Deprecated: This field is deprecated and will be removed.)* | +| `attributes` - [`[ProductViewAttribute]`](#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | +| `description` - [`String`](#string) | The detailed description of the product. | +| `id` - [`ID!`](#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image` or `swatch`. | +| `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | +| `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | +| `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | Product name. | +| `inputOptions` - [`[ProductViewInputOption]`](#productviewinputoption) | A list of input options. *(Deprecated: This field is deprecated and will be removed.)* | +| `options` - [`[ProductViewOption]`](#productviewoption) | A list of selectable options. | +| `priceRange` - [`ProductViewPriceRange`](#productviewpricerange) | A range of possible prices for a complex product. | +| `shortDescription` - [`String`](#string) | A summary of the product. | +| `sku` - [`String`](#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](#string) | The URL key of the product. | +| `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. Links are used to navigate from one product to another. | +| `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](#string) | Visibility setting of the product | #### Example ```json { - "brand": "abc123", - "expiry": "xyz789", - "last_digits": "xyz789" + "addToCartAllowed": false, + "inStock": false, + "lowStock": false, + "attributes": [ProductViewAttribute], + "description": "xyz789", + "id": "4", + "images": [ProductViewImage], + "videos": [ProductViewVideo], + "lastModifiedAt": "2007-12-03T10:15:30Z", + "metaDescription": "xyz789", + "metaKeyword": "abc123", + "metaTitle": "xyz789", + "name": "abc123", + "inputOptions": [ProductViewInputOption], + "options": [ProductViewOption], + "priceRange": ProductViewPriceRange, + "shortDescription": "abc123", + "sku": "abc123", + "externalId": "xyz789", + "url": "xyz789", + "urlKey": "abc123", + "links": [ProductViewLink], + "queryType": "abc123", + "visibility": "abc123" } ``` -### Cart - -Contains the contents and other details about a guest or customer cart. +### ComplexTextValue #### Fields | Field Name | Description | |------------|-------------| -| `applied_coupons` - [`[AppliedCoupon]`](#appliedcoupon) | An array of `AppliedCoupon` objects. Each object contains the `code` text attribute, which specifies the coupon code. | -| `applied_gift_cards` - [`[AppliedGiftCard]`](#appliedgiftcard) | An array of gift card items applied to the cart. | -| `applied_reward_points` - [`RewardPointsAmount`](#rewardpointsamount) | The amount of reward points applied to the cart. | -| `applied_store_credit` - [`AppliedStoreCredit`](#appliedstorecredit) | Store credit information applied to the cart. | -| `available_gift_wrappings` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of available payment methods. | -| `billing_address` - [`BillingCartAddress`](#billingcartaddress) | The billing address assigned to the cart. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart | -| `email` - [`String`](#string) | The email address of the guest or customer. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested gift receipt for the cart. | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart. | -| `id` - [`ID!`](#id) | The unique ID for a `Cart` object. | -| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the cart contains only virtual products. | -| `itemsV2` - [`CartItems`](#cartitems) | | -| `prices` - [`CartPrices`](#cartprices) | Pricing details for the quote. | -| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the shopper requested a printed card for the cart. | -| `rules` - [`[CartRuleStorefront]`](#cartrulestorefront) | Provides applied cart rules in the current active cart | -| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | Indicates which payment method was applied to the cart. | -| `shipping_addresses` - [`[ShippingCartAddress]!`](#shippingcartaddress) | An array of shipping addresses assigned to the cart. | -| `total_quantity` - [`Float!`](#float) | The total number of items in the cart. | +| `html` - [`String!`](#string) | Text that can contain HTML tags. | #### Example ```json -{ - "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, - "custom_attributes": [CustomAttribute], - "email": "abc123", - "gift_message": GiftMessage, - "gift_receipt_included": false, - "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": true, - "itemsV2": CartItems, - "prices": CartPrices, - "printed_card_included": true, - "rules": [CartRuleStorefront], - "selected_payment_method": SelectedPaymentMethod, - "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 -} +{"html": "abc123"} ``` -### CartAddressCountry - -Contains details the country in a billing or shipping address. +### ConditionInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The country code. | -| `label` - [`String!`](#string) | The display label for the country. | +| Input Field | Description | +|-------------|-------------| +| `field` - [`Field`](#field) | | +| `operator` - [`OperatorInput`](#operatorinput) | | +| `enabled` - [`Boolean`](#boolean) | | #### Example ```json { - "code": "xyz789", - "label": "xyz789" + "field": "UNKNOWN_FIELD", + "operator": OperatorInput, + "enabled": false } ``` -### CartAddressInput +### ConfigurableAttributeOption -Defines the billing or shipping address to be applied to the cart. +Contains details about a configurable product attribute option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | -| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | -| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The ID assigned to the attribute. | +| `label` - [`String`](#string) | A string that describes the configurable attribute option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | +| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | #### Example ```json { - "city": "xyz789", - "company": "abc123", - "country_code": "xyz789", - "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", - "region": "xyz789", - "region_id": 987, - "save_in_address_book": true, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "abc123" + "code": "abc123", + "label": "abc123", + "uid": "4", + "value_index": 123 } ``` -### CartAddressInterface +### ConfigurableCartItem + +An implementation for configurable product cart items. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | - -#### Possible Types - -| CartAddressInterface Types | -|----------------| -| [`BillingCartAddress`](#billingcartaddress) | -| [`ShippingCartAddress`](#shippingcartaddress) | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | +| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "city": "abc123", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "abc123", - "id": 123, - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", - "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "uid": 4, - "vat_id": "abc123" + "available_gift_wrapping": [GiftWrapping], + "backorder_message": "abc123", + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "custom_attributes": [CustomAttribute], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "is_available": false, + "is_salable": 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" } ``` -### CartAddressRegion +### ConfigurableOptionAvailableForSelection -Contains details about the region in a billing or shipping address. +Describes configurable options that have been selected and can be selected as a result of the previous selections. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The state or province code. | -| `label` - [`String`](#string) | The display label for the region. | -| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | #### Example ```json { - "code": "abc123", - "label": "xyz789", - "region_id": 987 + "attribute_code": "abc123", + "option_value_uids": ["4"] } ``` -### CartCustomAttributesInput - -Defines a cart custom attributes. +### ConfigurableOrderItem -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The cart ID. | -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart. | +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `parent_sku` - [`String`](#string) | The SKU of parent product. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "cart_id": "abc123", - "custom_attributes": [CustomAttributeInput] + "custom_attributes": [CustomAttribute], + "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": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "product_type": "xyz789", + "product_url_key": "abc123", + "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_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "abc123" } ``` -### CartDiscountType +### ConfigurableProduct -#### Values +Defines basic features of a configurable product and its simple product variants. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `ITEM` | | -| `SHIPPING` | | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | +| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | #### Example ```json -""ITEM"" -``` +{ + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "configurable_options": [ConfigurableProductOptions], + "configurable_product_options_selection": ConfigurableProductOptionsSelection, + "country_of_manufacture": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": false, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 123, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "abc123", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "related_products": [ProductInterface], + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_price": 987.65, + "special_to_date": "abc123", + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "uid": "4", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "variants": [ConfigurableVariant], + "weight": 123.45 +} +``` -### CartItemCustomAttributesInput +### ConfigurableProductOption -Defines a cart item custom attributes. +Contains details about configurable product options. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The cart ID. | -| `cart_item_id` - [`String!`](#string) | The cart item ID. | -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for cart item. | +| Field Name | Description | +|------------|-------------| +| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | +| `label` - [`String!`](#string) | The display name of the option. | +| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | +| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | #### Example ```json { - "cart_id": "abc123", - "cart_item_id": "xyz789", - "custom_attributes": [CustomAttributeInput] + "attribute_code": "xyz789", + "label": "xyz789", + "uid": 4, + "values": [ConfigurableProductOptionValue] } ``` -### CartItemError +### ConfigurableProductOptionValue + +Defines a value for a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`CartItemErrorType!`](#cartitemerrortype) | An error code that describes the error encountered | -| `message` - [`String!`](#string) | A localized error message | +| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | +| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | +| `label` - [`String!`](#string) | The display name of the value. | +| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | +| `uid` - [`ID!`](#id) | The unique ID of the value. | #### Example ```json -{"code": "UNDEFINED", "message": "abc123"} +{ + "is_available": true, + "is_use_default": true, + "label": "abc123", + "swatch": SwatchDataInterface, + "uid": 4 +} ``` -### CartItemErrorType +### ConfigurableProductOptions -#### Values +Defines configurable attributes for the specified product. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `UNDEFINED` | | -| `ITEM_QTY` | | -| `ITEM_INCREMENTS` | | +| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | +| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | +| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | +| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | +| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | +| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | #### Example ```json -""UNDEFINED"" +{ + "attribute_code": "abc123", + "attribute_uid": 4, + "label": "abc123", + "position": 123, + "uid": "4", + "use_default": true, + "values": [ConfigurableProductOptionsValues] +} ``` -### CartItemInput +### ConfigurableProductOptionsSelection -Defines an item to be added to the cart. +Contains metadata corresponding to the selected configurable options. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | An array of entered options for the base product, such as personalization text. | -| `parent_sku` - [`String`](#string) | For a child product, the SKU of its parent product. | -| `quantity` - [`Float!`](#float) | The amount or number of an item to add. | -| `selected_options` - [`[ID]`](#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!`](#string) | The SKU of the product. | +| Field Name | Description | +|------------|-------------| +| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | +| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | +| `variant` - [`SimpleProduct`](#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 ```json { - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": [4], - "sku": "abc123" + "configurable_options": [ConfigurableProductOption], + "media_gallery": [MediaGalleryInterface], + "options_available_for_selection": [ + ConfigurableOptionAvailableForSelection + ], + "variant": SimpleProduct } ``` -### CartItemInterface +### ConfigurableProductOptionsValues -An interface for products in a cart. +Contains the index number assigned to a configurable product option. #### Fields | Field Name | Description | |------------|-------------| -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | -| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | - -#### Possible Types - -| CartItemInterface Types | -|----------------| -| [`BundleCartItem`](#bundlecartitem) | -| [`ConfigurableCartItem`](#configurablecartitem) | -| [`DownloadableCartItem`](#downloadablecartitem) | -| [`GiftCardCartItem`](#giftcardcartitem) | -| [`SimpleCartItem`](#simplecartitem) | -| [`VirtualCartItem`](#virtualcartitem) | +| `default_label` - [`String`](#string) | The label of the product on the default store. | +| `label` - [`String`](#string) | The label of the product. | +| `store_label` - [`String`](#string) | The label of the product on the current store. | +| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | +| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | #### Example ```json { - "backorder_message": "xyz789", - "custom_attributes": [CustomAttribute], - "discount": [Discount], - "errors": [CartItemError], - "is_available": true, - "is_salable": false, - "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": 123.45, - "uid": 4 + "default_label": "xyz789", + "label": "xyz789", + "store_label": "abc123", + "swatch_data": SwatchDataInterface, + "uid": "4", + "use_default_value": false } ``` -### CartItemPrices +### ConfigurableRequisitionListItem -Contains details about the price of the item, including taxes and discounts. +Contains details about configurable products added to a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `catalog_discount` - [`ProductDiscount`](#productdiscount) | The price discount for the unit price of the item represents the difference between its regular price and final price. | -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of FPTs applied to the cart item. | -| `original_item_price` - [`Money!`](#money) | The value of the original unit price for the item, including discounts. | -| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | -| `price` - [`Money!`](#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!`](#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`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money`](#money) | The total of all discounts applied to the item. | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `sku` - [`String!`](#string) | The product SKU. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | #### Example ```json { - "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 + "configurable_options": [SelectedConfigurableOption], + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "sku": "abc123", + "uid": 4 } ``` -### CartItemSelectedOptionValuePrice +### ConfigurableVariant -Contains details about the price of a selected customizable value. +Contains all the simple product variants of a configurable product. #### Fields | Field Name | Description | |------------|-------------| -| `type` - [`PriceTypeEnum!`](#pricetypeenum) | Indicates whether the price type is fixed, percent, or dynamic. | -| `units` - [`String!`](#string) | A string that describes the unit of the value. | -| `value` - [`Float!`](#float) | A price value. | +| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | +| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | #### Example ```json { - "type": "FIXED", - "units": "abc123", - "value": 987.65 + "attributes": [ConfigurableAttributeOption], + "product": SimpleProduct } ``` -### CartItemUpdateInput +### ConfigurableWishlistItem -A single item to be updated. +A configurable product wish list item. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_item_uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | -| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | An array that defines customizable options for the product. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart item | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart item. | -| `quantity` - [`Float`](#float) | The new quantity of the item. | +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | +| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | #### Example ```json { - "cart_item_uid": "4", - "customizable_options": [CustomizableOptionInput], - "gift_message": GiftMessageInput, - "gift_wrapping_id": "4", + "added_at": "xyz789", + "configurable_options": [SelectedConfigurableOption], + "configured_variant": ProductInterface, + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, "quantity": 123.45 } ``` -### CartItems +### ConfirmCancelOrderInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `items` - [`[CartItemInterface]!`](#cartiteminterface) | An array of products that have been added to the cart. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int!`](#int) | The number of returned cart items. | +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | #### Example ```json { - "items": [CartItemInterface], - "page_info": SearchResultPageInfo, - "total_count": 987 + "confirmation_key": "abc123", + "order_id": "4" } ``` -### CartPrices +### ConfirmEmailInput -Contains details about the final price of items in the cart, including discount and tax information. +Contains details about a customer email address to confirm. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `applied_taxes` - [`[CartTaxItem]`](#carttaxitem) | An array containing the names and amounts of taxes applied to each item in the cart. | -| `discounts` - [`[Discount]`](#discount) | An array containing cart rule discounts, store credit and gift cards applied to the cart. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | The list of prices for the selected gift options. | -| `grand_total` - [`Money`](#money) | The total, including discounts, taxes, shipping, and other fees. | -| `grand_total_excluding_tax` - [`Money`](#money) | The total of the cart, including discounts, shipping, and other fees without tax. | -| `subtotal_excluding_tax` - [`Money`](#money) | The subtotal without any applied taxes. | -| `subtotal_including_tax` - [`Money`](#money) | The subtotal including any applied taxes. | -| `subtotal_with_discount_excluding_tax` - [`Money`](#money) | The subtotal with any discounts applied, but not taxes. | +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | +| `email` - [`String!`](#string) | The email address to be confirmed. | #### Example ```json { - "applied_taxes": [CartTaxItem], - "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 + "confirmation_key": "abc123", + "email": "abc123" } ``` -### CartRuleStorefront +### ConfirmReturnInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `uid` - [`ID!`](#id) | The unique ID for a `CartRule` object. | +| Input Field | Description | +|-------------|-------------| +| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | +| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | #### Example ```json -{"uid": 4} +{ + "confirmation_key": "abc123", + "order_id": "4" +} ``` -### CartTaxItem +### ConfirmationStatusEnum -Contains tax information about an item in the cart. +List of account confirmation statuses. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of tax applied to the item. | -| `label` - [`String!`](#string) | The description of the tax. | +| `ACCOUNT_CONFIRMED` | Account confirmed | +| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | #### Example ```json -{ - "amount": Money, - "label": "abc123" -} +""ACCOUNT_CONFIRMED"" ``` -### CartUserInputError +### ContactUsInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | -| `message` - [`String!`](#string) | A localized error message. | +| Input Field | Description | +|-------------|-------------| +| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | +| `email` - [`String!`](#string) | The email address of the shopper. | +| `name` - [`String!`](#string) | The full name of the shopper. | +| `telephone` - [`String`](#string) | The shopper's telephone number. | #### Example ```json { - "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "comment": "xyz789", + "email": "xyz789", + "name": "xyz789", + "telephone": "xyz789" } ``` -### CartUserInputErrorType +### ContactUsOutput -#### Values +Contains the status of the request. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `COULD_NOT_FIND_CART_ITEM` | | -| `REQUIRED_PARAMETER_MISSING` | | -| `INVALID_PARAMETER_VALUE` | | -| `UNDEFINED` | | -| `PERMISSION_DENIED` | | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | #### Example ```json -""PRODUCT_NOT_FOUND"" +{"status": true} ``` -### CatalogAttributeApplyToEnum +### CopyItemsBetweenRequisitionListsInput -#### Values +An input object that defines the items in a requisition list to be copied. -| Enum Value | Description | -|------------|-------------| -| `SIMPLE` | | -| `VIRTUAL` | | -| `BUNDLE` | | -| `DOWNLOADABLE` | | -| `CONFIGURABLE` | | -| `GROUPED` | | -| `CATEGORY` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | #### Example ```json -""SIMPLE"" +{"requisitionListItemUids": [4]} ``` -### CatalogAttributeMetadata +### CopyItemsFromRequisitionListsOutput -Swatch attribute metadata. +Output of the request to copy items to the destination requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `apply_to` - [`[CatalogAttributeApplyToEnum]`](#catalogattributeapplytoenum) | To which catalog types an attribute can be applied. | -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_comparable` - [`Boolean`](#boolean) | Whether a product or category attribute can be compared against another or not. | -| `is_filterable` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered or not. | -| `is_filterable_in_search` - [`Boolean`](#boolean) | Whether a product or category attribute can be filtered in search or not. | -| `is_html_allowed_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute can use HTML on front or not. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_searchable` - [`Boolean`](#boolean) | Whether a product or category attribute can be searched or not. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `is_used_for_price_rules` - [`Boolean`](#boolean) | Whether a product or category attribute can be used for price rules or not. | -| `is_used_for_promo_rules` - [`Boolean`](#boolean) | Whether a product or category attribute is used for promo rules or not. | -| `is_visible_in_advanced_search` - [`Boolean`](#boolean) | Whether a product or category attribute is visible in advanced search or not. | -| `is_visible_on_front` - [`Boolean`](#boolean) | Whether a product or category attribute is visible on front or not. | -| `is_wysiwyg_enabled` - [`Boolean`](#boolean) | Whether a product or category attribute has WYSIWYG enabled or not. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `swatch_input_type` - [`SwatchInputTypeEnum`](#swatchinputtypeenum) | Input type of the swatch attribute option. | -| `update_product_preview_image` - [`Boolean`](#boolean) | Whether update product preview image or not. | -| `use_product_image_for_swatch` - [`Boolean`](#boolean) | Whether use product image for swatch or not. | -| `used_in_product_listing` - [`Boolean`](#boolean) | Whether a product or category attribute is used in product listing or not. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | #### Example ```json -{ - "apply_to": ["SIMPLE"], - "code": "4", - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "is_comparable": true, - "is_filterable": true, - "is_filterable_in_search": true, - "is_html_allowed_on_front": true, - "is_required": false, - "is_searchable": true, - "is_unique": true, - "is_used_for_price_rules": true, - "is_used_for_promo_rules": false, - "is_visible_in_advanced_search": true, - "is_visible_on_front": true, - "is_wysiwyg_enabled": false, - "label": "xyz789", - "options": [CustomAttributeOptionInterface], - "swatch_input_type": "BOOLEAN", - "update_product_preview_image": true, - "use_product_image_for_swatch": true, - "used_in_product_listing": false -} +{"requisition_list": RequisitionList} ``` -### CategoryBucket +### CopyProductsBetweenWishlistsOutput -New category bucket for federation +Contains the source and target wish lists after copying products. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](#int) | | -| `id` - [`ID!`](#id) | | -| `path` - [`String!`](#string) | | -| `title` - [`String!`](#string) | | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | #### Example ```json { - "count": 123, - "id": 4, - "path": "abc123", - "title": "abc123" + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] } ``` -### CategoryBucketInterface +### Country #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | | - -#### Possible Types - -| CategoryBucketInterface Types | -|----------------| -| [`CategoryBucket`](#categorybucket) | +| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | +| `full_name_english` - [`String`](#string) | The name of the country in English. | +| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | +| `id` - [`String`](#string) | The unique ID for a `Country` object. | +| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | +| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | #### Example ```json -{"id": "4"} +{ + "available_regions": [Region], + "full_name_english": "abc123", + "full_name_locale": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "xyz789" +} ``` -### CategoryInterface +### CountryCodeEnum -Contains the full set of attributes that can be returned in a category search. +The list of country codes. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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`](#string) | | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | - -#### Possible Types - -| CategoryInterface Types | -|----------------| -| [`CategoryTree`](#categorytree) | - -#### Example - -```json -{ - "available_sort_by": ["xyz789"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "xyz789", - "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", - "description": "xyz789", - "display_mode": "abc123", - "filter_price_range": 987.65, - "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 987, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", - "path": "abc123", - "path_in_store": "xyz789", - "position": 123, - "product_count": 987, - "uid": 4, - "url_key": "xyz789", - "url_path": "abc123" -} -``` - - - -### CategoryTree - -Contains the hierarchy of categories. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_sort_by` - [`[String]`](#string) | | -| `breadcrumbs` - [`[Breadcrumb]`](#breadcrumb) | An array of breadcrumb items. | -| `canonical_url` - [`String`](#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`](#string) | | -| `custom_layout_update_file` - [`String`](#string) | | -| `default_sort_by` - [`String`](#string) | The attribute to use for sorting. | -| `description` - [`String`](#string) | An optional description of the category. | -| `display_mode` - [`String`](#string) | | -| `filter_price_range` - [`Float`](#float) | | -| `image` - [`String`](#string) | | -| `include_in_menu` - [`Int`](#int) | | -| `is_anchor` - [`Int`](#int) | | -| `landing_page` - [`Int`](#int) | | -| `level` - [`Int`](#int) | The depth of the category within the tree. | -| `meta_description` - [`String`](#string) | | -| `meta_keywords` - [`String`](#string) | | -| `meta_title` - [`String`](#string) | | -| `name` - [`String`](#string) | The display name of the category. | -| `path` - [`String`](#string) | The full category path. | -| `path_in_store` - [`String`](#string) | The category path within the store. | -| `position` - [`Int`](#int) | The position of the category relative to other categories at the same level in tree. | -| `product_count` - [`Int`](#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. | -| `uid` - [`ID!`](#id) | The unique ID for a `CategoryInterface` object. | -| `url_key` - [`String`](#string) | The URL key assigned to the category. | -| `url_path` - [`String`](#string) | The URL path assigned to the category. | - -#### Example - -```json -{ - "available_sort_by": ["abc123"], - "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "abc123", - "custom_layout_update_file": "abc123", - "default_sort_by": "abc123", - "description": "abc123", - "display_mode": "xyz789", - "filter_price_range": 987.65, - "image": "xyz789", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 123, - "level": 987, - "meta_description": "abc123", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", - "path": "xyz789", - "path_in_store": "abc123", - "position": 123, - "product_count": 987, - "uid": 4, - "url_key": "abc123", - "url_path": "xyz789" -} -``` - - - -### CategoryView - -Represents a category. Contains information about a category, including the category ID, the category name, the category path, the category URL key, the category URL path, and the category roles. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `availableSortBy` - [`[String]`](#string) | List of available sort by options. For example, `name`, `position` or `size`. | -| `children` - [`[String!]`](#string) | List of child category IDs. For example, `123`, `456` or `789`. | -| `defaultSortBy` - [`String`](#string) | Default sort by option. For example, `name`, `position` or `size`. | -| `id` - [`ID!`](#id) | Category ID. For example, `123`, `456` or `789`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | -| `level` - [`Int`](#int) | The level of the category. The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | -| `name` - [`String`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `parentId` - [`String!`](#string) | Parent category ID. For example, `123`, `456` or `789`. | -| `position` - [`Int`](#int) | The position of the category in sort order. For example, `1`, `2`, `3` or `10`. | -| `path` - [`String`](#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | -| `roles` - [`[String!]!`](#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | -| `urlKey` - [`String`](#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | -| `urlPath` - [`String`](#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | -| `count` - [`Int!`](#int) | *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | -| `title` - [`String!`](#string) | *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | - -#### Example - -```json -{ - "availableSortBy": ["abc123"], - "children": ["xyz789"], - "defaultSortBy": "abc123", - "id": 4, - "level": 987, - "name": "xyz789", - "parentId": "abc123", - "position": 987, - "path": "abc123", - "roles": ["xyz789"], - "urlKey": "abc123", - "urlPath": "xyz789", - "count": 987, - "title": "xyz789" -} -``` - - - -### CategoryViewInterface - -Base interface defining essential category fields shared across all category views. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `availableSortBy` - [`[String]`](#string) | List of available sort by options. For example, name, size or position. | -| `defaultSortBy` - [`String`](#string) | Default sort by option. For example, name, size or position. | -| `id` - [`ID!`](#id) | Category ID. For example, `123`, `456` or `789`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | -| `level` - [`Int`](#int) | The level of the category. The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | -| `name` - [`String`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `path` - [`String`](#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | -| `roles` - [`[String]`](#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | -| `urlKey` - [`String`](#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | -| `urlPath` - [`String`](#string) | Category URL path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. | - -#### Possible Types - -| CategoryViewInterface Types | -|----------------| -| [`CategoryView`](#categoryview) | - -#### Example - -```json -{ - "availableSortBy": ["xyz789"], - "defaultSortBy": "abc123", - "id": 4, - "level": 123, - "name": "abc123", - "path": "abc123", - "roles": ["xyz789"], - "urlKey": "xyz789", - "urlPath": "abc123" -} -``` - - - -### CheckoutAgreement - -Defines details about an individual checkout agreement. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `agreement_id` - [`Int!`](#int) | The ID for a checkout agreement. | -| `checkbox_text` - [`String!`](#string) | The checkbox text for the checkout agreement. | -| `content` - [`String!`](#string) | Required. The text of the agreement. | -| `content_height` - [`String`](#string) | The height of the text box where the Terms and Conditions statement appears during checkout. | -| `is_html` - [`Boolean!`](#boolean) | Indicates whether the `content` text is in HTML format. | -| `mode` - [`CheckoutAgreementMode!`](#checkoutagreementmode) | Indicates whether agreements are accepted automatically or manually. | -| `name` - [`String!`](#string) | The name given to the condition. | - -#### Example - -```json -{ - "agreement_id": 123, - "checkbox_text": "xyz789", - "content": "abc123", - "content_height": "abc123", - "is_html": false, - "mode": "AUTO", - "name": "abc123" -} -``` - - - -### CheckoutAgreementMode - -Indicates how agreements are accepted. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `AUTO` | Conditions are automatically accepted upon checkout. | -| `MANUAL` | Shoppers must manually accept the conditions to place an order. | - -#### Example - -```json -""AUTO"" -``` - - - -### CheckoutUserInputError - -An error encountered while adding an item to the cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`CheckoutUserInputErrorCodes!`](#checkoutuserinputerrorcodes) | An error code that is specific to Checkout. | -| `message` - [`String!`](#string) | A localized error message. | -| `path` - [`[String]!`](#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 - -```json -{ - "code": "REORDER_NOT_AVAILABLE", - "message": "abc123", - "path": ["abc123"] -} -``` - - - -### CheckoutUserInputErrorCodes - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `REORDER_NOT_AVAILABLE` | | -| `PRODUCT_NOT_FOUND` | | -| `NOT_SALABLE` | | -| `INSUFFICIENT_STOCK` | | -| `UNDEFINED` | | - -#### Example - -```json -""REORDER_NOT_AVAILABLE"" -``` - - - -### ClearCustomerCartOutput - -Output of the request to clear the customer cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after clearing items. | -| `status` - [`Boolean!`](#boolean) | Indicates whether cart was cleared. | - -#### Example - -```json -{"cart": Cart, "status": true} -``` - - - -### CloseNegotiableQuoteError - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | -| [`NoSuchEntityUidError`](#nosuchentityuiderror) | -| [`InternalError`](#internalerror) | - -#### Example - -```json -NegotiableQuoteInvalidStateError -``` - - - -### CloseNegotiableQuoteOperationFailure - -Contains details about a failed close operation on a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `errors` - [`[CloseNegotiableQuoteError]!`](#closenegotiablequoteerror) | An array of errors encountered while attempting close the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" -} -``` - - - -### CloseNegotiableQuoteOperationResult - -#### Types - -| Union Types | -|-------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | -| [`CloseNegotiableQuoteOperationFailure`](#closenegotiablequoteoperationfailure) | +| `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 ```json -NegotiableQuoteUidOperationSuccess +""AF"" ``` -### CloseNegotiableQuotesInput +### CreateCompanyOutput -Defines the negotiable quotes to mark as closed. +Contains the response to the request to create a company. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs from `NegotiableQuote` objects. | +| Field Name | Description | +|------------|-------------| +| `company` - [`Company!`](#company) | The new company instance. | #### Example ```json -{"quote_uids": ["4"]} +{"company": Company} ``` -### CloseNegotiableQuotesOutput +### CreateCompanyRoleOutput -Contains the closed negotiable quotes and other negotiable quotes the company user can view. +Contains the response to the request to create a company role. #### Fields | Field Name | Description | |------------|-------------| -| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that can be viewed by the logged-in customer | -| `operation_results` - [`[CloseNegotiableQuoteOperationResult]!`](#closenegotiablequoteoperationresult) | An array of closed negotiable quote UIDs and details about any errors. | -| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to close one or more negotiable quotes. | +| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | #### Example ```json -{ - "negotiable_quotes": NegotiableQuotesOutput, - "operation_results": [ - NegotiableQuoteUidOperationSuccess - ], - "result_status": "SUCCESS" -} +{"role": CompanyRole} ``` -### ColorSwatchData +### CreateCompanyTeamOutput + +Contains the response to the request to create a company team. #### Fields | Field Name | Description | |------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | +| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | #### Example ```json -{"value": "xyz789"} +{"team": CompanyTeam} ``` -### CommerceOptimizerContext +### CreateCompanyUserOutput -Commerce Optimizer entities +Contains the response to the request to create a company user. #### Fields | Field Name | Description | |------------|-------------| -| `priceBookId` - [`ID!`](#id) | The priceBookId for current customer session. | +| `user` - [`Customer!`](#customer) | The new company user instance. | #### Example ```json -{"priceBookId": "4"} +{"user": Customer} ``` -### CompaniesSortFieldEnum +### CreateCompareListInput -The fields available for sorting the customer companies. +Contains an array of product IDs to use for creating a compare list. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `NAME` | The name of the company. | +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | #### Example ```json -""NAME"" +{"products": [4]} ``` -### CompaniesSortInput +### CreateGiftRegistryInput -Specifies which field to sort on, and whether to return the results in ascending or descending order. +Defines a new gift registry. #### Input Fields | Input Field | Description | |-------------|-------------| -| `field` - [`CompaniesSortFieldEnum!`](#companiessortfieldenum) | The field for sorting the results. | -| `order` - [`SortEnum!`](#sortenum) | Indicates whether to return results in ascending or descending order. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | +| `message` - [`String!`](#string) | A message describing the event. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | +| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | +| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | #### Example ```json -{"field": "NAME", "order": "ASC"} +{ + "dynamic_attributes": [ + GiftRegistryDynamicAttributeInput + ], + "event_name": "xyz789", + "gift_registry_type_uid": "4", + "message": "xyz789", + "privacy_settings": "PRIVATE", + "registrants": [AddGiftRegistryRegistrantInput], + "shipping_address": GiftRegistryShippingAddressInput, + "status": "ACTIVE" +} ``` -### Company +### CreateGiftRegistryOutput -Contains the output schema for a company. +Contains the results of a request to create a gift registry. #### Fields | Field Name | Description | |------------|-------------| -| `acl_resources` - [`[CompanyAclResource]`](#companyaclresource) | The list of all resources defined within the company. | -| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | Available payment methods for the company with proper B2B configuration and company-specific filtering. | -| `available_shipping_methods` - [`[CompanyAvailableShippingMethod]`](#companyavailableshippingmethod) | Available shipping carriers for the company with proper B2B configuration and company-specific filtering. | -| `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | -| `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | -| `credit_history` - [`CompanyCreditHistory!`](#companycredithistory) | Details about the history of company credit operations. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the company | -| `email` - [`String`](#string) | The email address of the company contact. | -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `legal_address` - [`CompanyLegalAddress`](#companylegaladdress) | The address where the company is registered to conduct business. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `payment_methods` - [`[String]`](#string) | The list of payment methods available to a company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `role` - [`CompanyRole`](#companyrole) | A company role filtered by the unique ID of a `CompanyRole` object. | -| `roles` - [`CompanyRoles!`](#companyroles) | An object that contains a list of company roles. | -| `sales_representative` - [`CompanySalesRepresentative`](#companysalesrepresentative) | An object containing information about the company sales representative. | -| `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | -| `structure` - [`CompanyStructure`](#companystructure) | The company structure of teams and customers in depth-first order. | -| `team` - [`CompanyTeam`](#companyteam) | The company team data filtered by the unique ID for a `CompanyTeam` object. | -| `user` - [`Customer`](#customer) | A company user filtered by the unique ID of a `Customer` object. | -| `users` - [`CompanyUsers`](#companyusers) | An object that contains a list of company users based on activity status. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | #### Example ```json -{ - "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, - "legal_address": CompanyLegalAddress, - "legal_name": "xyz789", - "name": "xyz789", - "payment_methods": ["abc123"], - "reseller_id": "xyz789", - "role": CompanyRole, - "roles": CompanyRoles, - "sales_representative": CompanySalesRepresentative, - "status": "PENDING", - "structure": CompanyStructure, - "team": CompanyTeam, - "user": Customer, - "users": CompanyUsers, - "vat_tax_id": "abc123" -} +{"gift_registry": GiftRegistry} ``` -### CompanyAclResource +### CreateGuestCartInput -Contains details about the access control list settings of a resource. +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_uid` - [`ID`](#id) | Optional client-generated ID | + +#### Example + +```json +{"cart_uid": 4} +``` + + + +### CreateGuestCartOutput #### Fields | Field Name | Description | |------------|-------------| -| `children` - [`[CompanyAclResource]`](#companyaclresource) | An array of sub-resources. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyAclResource` object. | -| `sort_order` - [`Int`](#int) | The sort order of an ACL resource. | -| `text` - [`String`](#string) | The label assigned to the ACL resource. | +| `cart` - [`Cart`](#cart) | The newly created cart. | #### Example ```json -{ - "children": [CompanyAclResource], - "id": 4, - "sort_order": 987, - "text": "abc123" -} +{"cart": Cart} ``` -### CompanyAdminInput +### CreatePaymentOrderInput -Defines the input schema for creating a company administrator. +Contains payment order details that are used while processing the payment order #### Input Fields | Input Field | Description | |-------------|-------------| -| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The company administrator's custom attributes. | -| `email` - [`String!`](#string) | The email address of the company administrator. | -| `firstname` - [`String!`](#string) | The company administrator's first name. | -| `gender` - [`Int`](#int) | The company administrator's gender (Male - 1, Female - 2, Not Specified - 3). | -| `job_title` - [`String`](#string) | The job title of the company administrator. | -| `lastname` - [`String!`](#string) | The company administrator's last name. | -| `telephone` - [`String`](#string) | The phone number of the company administrator. | +| `cartId` - [`String!`](#string) | The customer cart ID | +| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | +| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | +| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | +| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | #### Example ```json { - "custom_attributes": [AttributeValueInput], - "email": "abc123", - "firstname": "abc123", - "gender": 123, - "job_title": "xyz789", - "lastname": "abc123", - "telephone": "abc123" + "cartId": "xyz789", + "location": "PRODUCT_DETAIL", + "methodCode": "abc123", + "paymentSource": "abc123", + "vaultIntent": true } ``` -### CompanyAvailableShippingMethod +### CreatePaymentOrderOutput -Describes a carrier-level shipping option available to the company. +Contains payment order details that are used while processing the payment order #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | | -| `title` - [`String!`](#string) | | +| `amount` - [`Float`](#float) | The amount of the payment order | +| `currency_code` - [`String`](#string) | The currency of the payment order | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json { - "code": "xyz789", - "title": "xyz789" + "amount": 123.45, + "currency_code": "abc123", + "id": "xyz789", + "mp_order_id": "xyz789", + "status": "abc123" } ``` -### CompanyBasicInfo +### CreatePurchaseOrderApprovalRuleConditionAmountInput -The minimal required information to identify and display the company. +Specifies the amount and currency to evaluate. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `id` - [`ID!`](#id) | The unique ID of a `Company` object. | -| `is_admin` - [`Boolean!`](#boolean) | Indicates whether the company is the admin (parent) company in the returned relation hierarchy. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `name` - [`String`](#string) | The name of the company. | -| `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | +| Input Field | Description | +|-------------|-------------| +| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | +| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | #### Example ```json -{ - "id": 4, - "is_admin": true, - "legal_name": "xyz789", - "name": "abc123", - "status": "PENDING" -} +{"currency": "AFN", "value": 123.45} ``` -### CompanyCreateInput +### CreatePurchaseOrderApprovalRuleConditionInput -Defines the input schema for creating a new company. +Defines a set of conditions that apply to a rule. #### Input Fields | Input Field | Description | |-------------|-------------| -| `company_admin` - [`CompanyAdminInput!`](#companyadmininput) | Defines the company administrator. | -| `company_email` - [`String!`](#string) | The email address of the company contact. | -| `company_name` - [`String!`](#string) | The name of the company to create. | -| `legal_address` - [`CompanyLegalAddressCreateInput!`](#companylegaladdresscreateinput) | Defines legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | +| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | +| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | #### Example ```json { - "company_admin": CompanyAdminInput, - "company_email": "abc123", - "company_name": "abc123", - "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", - "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN", + "quantity": 123 } ``` -### CompanyCredit +### CreateRequisitionListInput -Contains company credit balances and limits. +An input object that identifies and describes a new requisition list. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `available_credit` - [`Money!`](#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!`](#money) | The amount of credit extended to the company. | -| `exceed_limit` - [`Boolean!`](#boolean) | Indicates whether company credit functionality is allowed to exceed current company credit limit. | -| `outstanding_balance` - [`Money!`](#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. | +| Input Field | Description | +|-------------|-------------| +| `description` - [`String`](#string) | An optional description of the requisition list. | +| `name` - [`String!`](#string) | The name assigned to the requisition list. | #### Example ```json { - "available_credit": Money, - "credit_limit": Money, - "exceed_limit": false, - "outstanding_balance": Money + "description": "abc123", + "name": "xyz789" } ``` -### CompanyCreditHistory +### CreateRequisitionListOutput -Contains details about prior company credit operations. +Output of the request to create a requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyCreditOperation]!`](#companycreditoperation) | An array of company credit operations. | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Metadata for pagination rendering. | -| `total_count` - [`Int`](#int) | The number of the company credit operations matching the specified filter. | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | #### Example ```json -{ - "items": [CompanyCreditOperation], - "page_info": SearchResultPageInfo, - "total_count": 123 -} +{"requisition_list": RequisitionList} ``` -### CompanyCreditHistoryFilterInput +### CreateVaultCardPaymentTokenInput -Defines a filter for narrowing the results of a credit history search. +Describe the variables needed to create a vault payment token #### Input Fields | Input Field | Description | |-------------|-------------| -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `operation_type` - [`CompanyCreditOperationType`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`String`](#string) | The name of the person submitting the company credit operation. | +| `card_description` - [`String`](#string) | Description of the vaulted card | +| `setup_token_id` - [`String!`](#string) | The setup token obtained by the createVaultCardSetupToken endpoint | #### Example ```json { - "custom_reference_number": "xyz789", - "operation_type": "ALLOCATION", - "updated_by": "abc123" + "card_description": "xyz789", + "setup_token_id": "abc123" } ``` -### CompanyCreditOperation +### CreateVaultCardPaymentTokenOutput -Contains details about a single company credit operation. +The vault token id and information about the payment source #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money`](#money) | The amount of the company credit operation. | -| `balance` - [`CompanyCredit!`](#companycredit) | The credit balance as a result of the operation. | -| `custom_reference_number` - [`String`](#string) | The purchase order number associated with the company credit operation. | -| `date` - [`String!`](#string) | The date the operation occurred. | -| `type` - [`CompanyCreditOperationType!`](#companycreditoperationtype) | The type of the company credit operation. | -| `updated_by` - [`CompanyCreditOperationUser!`](#companycreditoperationuser) | The company user that submitted the company credit operation. | +| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | +| `vault_token_id` - [`String!`](#string) | The vault payment token information | #### Example ```json { - "amount": Money, - "balance": CompanyCredit, - "custom_reference_number": "abc123", - "date": "xyz789", - "type": "ALLOCATION", - "updated_by": CompanyCreditOperationUser + "payment_source": PaymentSourceOutput, + "vault_token_id": "xyz789" } ``` -### CompanyCreditOperationType +### CreateVaultCardSetupTokenInput -#### Values +Describe the variables needed to create a vault card setup token -| Enum Value | Description | -|------------|-------------| -| `ALLOCATION` | | -| `UPDATE` | | -| `PURCHASE` | | -| `REIMBURSEMENT` | | -| `REFUND` | | -| `REVERT` | | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | #### Example ```json -""ALLOCATION"" +{ + "setup_token": VaultSetupTokenInput, + "three_ds_mode": "OFF" +} ``` -### CompanyCreditOperationUser +### CreateVaultCardSetupTokenOutput -Defines the administrator or company user that submitted a company credit operation. +The setup token id information #### Fields | Field Name | Description | |------------|-------------| -| `name` - [`String!`](#string) | The name of the company user submitting the company credit operation. | -| `type` - [`CompanyCreditOperationUserType!`](#companycreditoperationusertype) | The type of the company user submitting the company credit operation. | +| `setup_token` - [`String!`](#string) | The setup token id | #### Example ```json -{"name": "abc123", "type": "CUSTOMER"} +{"setup_token": "abc123"} ``` -### CompanyCreditOperationUserType +### CreateWishlistInput -#### Values +Defines the name and visibility of a new wish list. -| Enum Value | Description | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`String!`](#string) | The name of the new wish list. | +| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | + +#### Example + +```json +{"name": "xyz789", "visibility": "PUBLIC"} +``` + + + +### CreateWishlistOutput + +Contains the wish list. + +#### Fields + +| Field Name | Description | |------------|-------------| -| `CUSTOMER` | | -| `ADMIN` | | +| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | #### Example ```json -""CUSTOMER"" +{"wishlist": Wishlist} ``` -### CompanyHierarchy +### CreditMemo -Defines a parent company and its direct child companies. +Contains credit memo details. #### Fields | Field Name | Description | |------------|-------------| -| `children` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of direct child companies. | -| `parent` - [`CompanyBasicInfo`](#companybasicinfo) | The parent company in the relation hierarchy. Null if the company has no parent. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | +| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | +| `number` - [`String!`](#string) | The sequential credit memo number. | +| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | #### Example ```json { - "children": [CompanyBasicInfo], - "parent": CompanyBasicInfo + "comments": [SalesCommentItem], + "custom_attributes": [CustomAttribute], + "id": 4, + "items": [CreditMemoItemInterface], + "number": "xyz789", + "total": CreditMemoTotal } ``` -### CompanyInvitationInput +### CreditMemoCustomAttributesInput -Defines the input schema for accepting the company invitation. +Defines a credit memo item's custom attributes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `code` - [`String!`](#string) | The invitation code. | -| `role_id` - [`ID`](#id) | The company role id. | -| `user` - [`CompanyInvitationUserInput!`](#companyinvitationuserinput) | Company user attributes in the invitation. | +| `credit_memo_id` - [`String!`](#string) | The credit memo ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for the credit memo. | #### Example ```json { - "code": "xyz789", - "role_id": "4", - "user": CompanyInvitationUserInput + "credit_memo_id": "abc123", + "custom_attributes": [CustomAttributeInput] } ``` -### CompanyInvitationOutput - -The result of accepting the company invitation. +### CreditMemoItem #### Fields | Field Name | Description | |------------|-------------| -| `success` - [`Boolean`](#boolean) | Indicates whether the customer was added to the company successfully. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | #### Example ```json -{"success": true} +{ + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_refunded": 987.65 +} ``` -### CompanyInvitationUserInput +### CreditMemoItemCustomAttributesInput -Company user attributes in the invitation. +Defines a credit memo's custom attributes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `company_id` - [`ID!`](#id) | The company unique identifier. | -| `customer_id` - [`ID!`](#id) | The customer unique identifier. | -| `job_title` - [`String`](#string) | The job title of a company user. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The phone number of the company user. | +| `credit_memo_id` - [`String!`](#string) | The credit memo ID. | +| `credit_memo_item_id` - [`String!`](#string) | The credit memo item ID. | +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for the credit memo item. | #### Example ```json { - "company_id": 4, - "customer_id": "4", - "job_title": "xyz789", - "status": "ACTIVE", - "telephone": "abc123" + "credit_memo_id": "abc123", + "credit_memo_item_id": "abc123", + "custom_attributes": [CustomAttributeInput] } ``` -### CompanyLegalAddress +### CreditMemoItemInterface -Contains details about the address where the company is registered to conduct business. +Credit memo item details. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The country code of the company's legal address. | -| `postcode` - [`String`](#string) | The company's postal code. | -| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing region data for the company. | -| `street` - [`[String]`](#string) | An array of strings that define the company's street address. | -| `telephone` - [`String`](#string) | The company's phone number. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Possible Types + +| CreditMemoItemInterface Types | +|----------------| +| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | +| [`CreditMemoItem`](#creditmemoitem) | +| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | +| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | #### Example ```json { - "city": "xyz789", - "country_code": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegion, - "street": ["xyz789"], - "telephone": "abc123" + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 } ``` -### CompanyLegalAddressCreateInput +### CreditMemoOutput -Defines the input schema for defining a company's legal address. +Contains details about the credit memo after adding custom attributes to it. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String!`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum!`](#countrycodeenum) | The company's country ID. Use the `countries` query to get this value. | -| `postcode` - [`String!`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput!`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]!`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String!`](#string) | The primary phone number of the company. | +| Field Name | Description | +|------------|-------------| +| `credit_memo` - [`CreditMemo!`](#creditmemo) | The custom attributes to credit memo have been added. | #### Example ```json -{ - "city": "abc123", - "country_id": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "xyz789" -} +{"credit_memo": CreditMemo} ``` -### CompanyLegalAddressUpdateInput +### CreditMemoTotal -Defines the input schema for updating a company's legal address. +Contains credit memo price details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`String`](#string) | The city where the company is registered to conduct business. | -| `country_id` - [`CountryCodeEnum`](#countrycodeenum) | The unique ID for a `Country` object. | -| `postcode` - [`String`](#string) | The postal code of the company. | -| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name and/or region ID where the company is registered to conduct business. | -| `street` - [`[String]`](#string) | An array of strings that define the street address where the company is registered to conduct business. | -| `telephone` - [`String`](#string) | The primary phone number of the company. | +| Field Name | Description | +|------------|-------------| +| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | #### Example ```json { - "city": "abc123", - "country_id": "AF", - "postcode": "xyz789", - "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "abc123" + "adjustment": Money, + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money } ``` -### CompanyRole - -Contails details about a single role. +### Currency #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name assigned to the role. | -| `permissions` - [`[CompanyAclResource]`](#companyaclresource) | A list of permission resources defined for a role. | -| `users_count` - [`Int`](#int) | The total number of users assigned the specified role. | +| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | +| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | +| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | +| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | +| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | +| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | #### Example ```json { - "id": "4", - "name": "abc123", - "permissions": [CompanyAclResource], - "users_count": 123 + "available_currency_codes": ["abc123"], + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "abc123", + "exchange_rates": [ExchangeRate] } ``` -### CompanyRoleCreateInput +### CurrencyEnum -Defines the input schema for creating a company role. +The list of available currency codes. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the role to create. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| Enum Value | Description | +|------------|-------------| +| `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` | | +| `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 ```json -{ - "name": "xyz789", - "permissions": ["abc123"] -} +""AFN"" ``` -### CompanyRoleUpdateInput +### CurrentProductInput -Defines the input schema for updating a company role. +Attributes of the product currently being viewed on PDP #### Input Fields | Input Field | Description | |-------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `name` - [`String`](#string) | The name of the role to update. | -| `permissions` - [`[String]`](#string) | A list of resources the role can access. | +| `sku` - [`String`](#string) | SKU of the current product | +| `price` - [`Float`](#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | #### Example ```json -{ - "id": "4", - "name": "xyz789", - "permissions": ["xyz789"] -} +{"sku": "abc123", "price": 123.45} ``` -### CompanyRoles +### CustomAttribute -Contains an array of roles. +Specifies the custom attribute code and value. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyRole]!`](#companyrole) | A list of company roles that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The total number of objects matching the specified filter. | +| `attribute_code` - [`String`](#string) | The custom attribute code. | +| `value` - [`String`](#string) | The custom attribute code value. | #### Example ```json { - "items": [CompanyRole], - "page_info": SearchResultPageInfo, - "total_count": 123 + "attribute_code": "abc123", + "value": "abc123" } ``` -### CompanySalesRepresentative +### CustomAttributeInput -Contains details about a company sales representative. +Defines a custom attribute. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `email` - [`String`](#string) | The email address of the company sales representative. | -| `firstname` - [`String`](#string) | The company sales representative's first name. | -| `lastname` - [`String`](#string) | The company sales representative's last name. | +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | Attribute Code. | +| `value` - [`String!`](#string) | Attribute Value. | #### Example ```json { - "email": "abc123", - "firstname": "abc123", - "lastname": "abc123" + "attribute_code": "xyz789", + "value": "xyz789" } ``` -### CompanyStatusEnum - -Defines the list of company status values. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | Company is pending approval. | -| `APPROVED` | Company is approved. | -| `REJECTED` | Company is rejected. | -| `BLOCKED` | Company is blocked. | - -#### Example - -```json -""PENDING"" -``` - - - -### CompanyStructure +### CustomAttributeMetadataInterface -Contains an array of the individual nodes that comprise the company structure. +An interface containing fields that define the EAV attribute. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[CompanyStructureItem]`](#companystructureitem) | An array of elements in a company structure. | - -#### Example - -```json -{"items": [CompanyStructureItem]} -``` - - - -### CompanyStructureEntity +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -#### Types +#### Possible Types -| Union Types | -|-------------| -| [`CompanyTeam`](#companyteam) | -| [`Customer`](#customer) | +| CustomAttributeMetadataInterface Types | +|----------------| +| [`AttributeMetadata`](#attributemetadata) | +| [`CatalogAttributeMetadata`](#catalogattributemetadata) | +| [`CustomerAttributeMetadata`](#customerattributemetadata) | +| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | #### Example ```json -CompanyTeam +{ + "code": "4", + "default_value": "abc123", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "frontend_input": "BOOLEAN", + "is_required": true, + "is_unique": false, + "label": "abc123", + "options": [CustomAttributeOptionInterface] +} ``` -### CompanyStructureItem - -Defines an individual node in the company structure. +### CustomAttributeOptionInterface #### Fields | Field Name | Description | |------------|-------------| -| `entity` - [`CompanyStructureEntity`](#companystructureentity) | A union of `CompanyTeam` and `Customer` objects. | -| `id` - [`ID!`](#id) | The unique ID for a `CompanyStructureItem` object. | -| `parent_id` - [`ID`](#id) | The ID of the parent item in the company hierarchy. | - -#### Example - -```json -{ - "entity": CompanyTeam, - "id": "4", - "parent_id": 4 -} -``` - - - -### CompanyStructureUpdateInput - -Defines the input schema for updating the company structure. +| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | +| `label` - [`String!`](#string) | The label assigned to the attribute option. | +| `value` - [`String!`](#string) | The attribute option value. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `parent_tree_id` - [`ID!`](#id) | The ID of a company that will be the new parent. | -| `tree_id` - [`ID!`](#id) | The ID of the company team that is being moved to another parent. | +| CustomAttributeOptionInterface Types | +|----------------| +| [`AttributeOptionMetadata`](#attributeoptionmetadata) | #### Example ```json -{"parent_tree_id": "4", "tree_id": 4} +{ + "is_default": false, + "label": "abc123", + "value": "xyz789" +} ``` -### CompanyTeam +### CustomConfigKeyValue -Describes a company team. +A simple key value object. #### Fields | Field Name | Description | |------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID`](#id) | The unique ID for a `CompanyTeam` object. | -| `name` - [`String`](#string) | The display name of the team. | -| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `key` - [`String`](#string) | | +| `value` - [`String`](#string) | | #### Example ```json { - "description": "xyz789", - "id": 4, - "name": "xyz789", - "structure_id": "4" + "key": "abc123", + "value": "abc123" } ``` -### CompanyTeamCreateInput - -Defines the input schema for creating a company team. +### CustomOperatorInput #### Input Fields | Input Field | Description | |-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `name` - [`String!`](#string) | The display name of the team. | -| `target_id` - [`ID`](#id) | The ID of a node within a company's structure. This ID will be the parent of the created team. | +| `type` - [`CustomOperatorType`](#customoperatortype) | | +| `value` - [`[String]`](#string) | | #### Example ```json { - "description": "xyz789", - "name": "xyz789", - "target_id": "4" + "type": "UNKNOWN_CUSTOMOPERATOR_TYPE", + "value": ["abc123"] } ``` -### CompanyTeamUpdateInput - -Defines the input schema for updating a company team. +### CustomOperatorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the team. | -| `id` - [`ID!`](#id) | The unique ID of the `CompanyTeam` object to update. | -| `name` - [`String`](#string) | The display name of the team. | +| Enum Value | Description | +|------------|-------------| +| `UNKNOWN_CUSTOMOPERATOR_TYPE` | | +| `CUSTOM` | | #### Example ```json -{ - "description": "xyz789", - "id": 4, - "name": "abc123" -} +""UNKNOWN_CUSTOMOPERATOR_TYPE"" ``` -### CompanyUpdateInput +### Customer -Defines the input schema for updating a company. +Defines the customer name, addresses, and other details. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `company_email` - [`String`](#string) | The email address of the company contact. | -| `company_name` - [`String`](#string) | The name of the company to update. | -| `legal_address` - [`CompanyLegalAddressUpdateInput`](#companylegaladdressupdateinput) | The legal address data of the company. | -| `legal_name` - [`String`](#string) | The full legal name of the company. | -| `reseller_id` - [`String`](#string) | The resale number that is assigned to the company for tax reporting purposes. | -| `vat_tax_id` - [`String`](#string) | The value-added tax number that is assigned to the company by some jurisdictions for tax reporting purposes. | +| Field Name | Description | +|------------|-------------| +| `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | +| `admin_assistance_actions` - [`AdminAssistanceActions!`](#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | +| `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `company_hierarchy` - [`[CompanyHierarchy]`](#companyhierarchy) | The company relation hierarchies for all companies. Only available to the company administrator. | +| `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | +| `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | +| `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | Customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `default_billing` - [`String`](#string) | The ID assigned to the billing address. | +| `default_shipping` - [`String`](#string) | The ID assigned to the shipping address. | +| `email` - [`String`](#string) | The customer's email address. Required. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `gift_registries` - [`[GiftRegistry]`](#giftregistry) | Details about all of the customer's gift registries. | +| `gift_registry` - [`GiftRegistry`](#giftregistry) | Details about a specific gift registry. | +| `group` - [`CustomerGroupStorefront`](#customergroupstorefront) | Customer group assigned to the customer | +| `id` - [`ID!`](#id) | The unique ID assigned to the customer. *(Deprecated: `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`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `job_title` - [`String`](#string) | The job title of a company user. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `orders` - [`CustomerOrders`](#customerorders) | | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `purchase_order` - [`PurchaseOrder`](#purchaseorder) | Purchase order details. | +| `purchase_order_approval_rule` - [`PurchaseOrderApprovalRule`](#purchaseorderapprovalrule) | Details about a single purchase order approval rule. | +| `purchase_order_approval_rule_metadata` - [`PurchaseOrderApprovalRuleMetadata`](#purchaseorderapprovalrulemetadata) | Purchase order approval rule metadata that can be used for rule edit form rendering. | +| `purchase_order_approval_rules` - [`PurchaseOrderApprovalRules`](#purchaseorderapprovalrules) | A list of purchase order approval rules visible to the customer. | +| `purchase_orders` - [`PurchaseOrders`](#purchaseorders) | A list of purchase orders visible to the customer. | +| `purchase_orders_enabled` - [`Boolean!`](#boolean) | Indicates whether purchase order functionality is enabled for the current customer. Global and company-level settings are factored into the result. | +| `quote_enabled` - [`Boolean!`](#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`](#requisitionlists) | An object that contains the customer's requisition lists. | +| `return` - [`Return`](#return) | Details about the specified return request from the unique ID for a `Return` object. | +| `returns` - [`Returns`](#returns) | Information about the customer's return requests. | +| `reward_points` - [`RewardPoints`](#rewardpoints) | Customer reward points details. | +| `role` - [`CompanyRole`](#companyrole) | The role name and permissions assigned to the company user. | +| `segments` - [`[CustomerSegmentStorefront]`](#customersegmentstorefront) | Customer segments associated with the current customer | +| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | +| `store_credit` - [`CustomerStoreCredit`](#customerstorecredit) | Store credit information applied for the logged in customer. | +| `structure_id` - [`ID!`](#id) | ID of the company structure | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| `team` - [`CompanyTeam`](#companyteam) | The team the company user is assigned to. | +| `telephone` - [`String`](#string) | The phone number of the company user. | +| `wishlist_v2` - [`Wishlist`](#wishlist) | Retrieve the wish list identified by the unique ID for a `Wishlist` object. | +| `wishlists` - [`[Wishlist]!`](#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. | #### Example ```json { - "company_email": "xyz789", - "company_name": "abc123", - "legal_address": CompanyLegalAddressUpdateInput, - "legal_name": "abc123", - "reseller_id": "xyz789", - "vat_tax_id": "abc123" + "addresses": [CustomerAddress], + "addressesV2": CustomerAddresses, + "admin_assistance_actions": AdminAssistanceActions, + "allow_remote_shopping_assistance": false, + "companies": UserCompaniesOutput, + "company_hierarchy": [CompanyHierarchy], + "compare_list": CompareList, + "confirmation_status": "ACCOUNT_CONFIRMED", + "created_at": "abc123", + "custom_attributes": [AttributeValueInterface], + "date_of_birth": "abc123", + "default_billing": "xyz789", + "default_shipping": "xyz789", + "email": "abc123", + "firstname": "abc123", + "gender": 987, + "gift_registries": [GiftRegistry], + "gift_registry": GiftRegistry, + "group": CustomerGroupStorefront, + "id": 4, + "is_subscribed": true, + "job_title": "abc123", + "lastname": "xyz789", + "middlename": "abc123", + "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, + "quote_enabled": true, + "requisition_lists": RequisitionLists, + "return": Return, + "returns": Returns, + "reward_points": RewardPoints, + "role": CompanyRole, + "segments": [CustomerSegmentStorefront], + "status": "ACTIVE", + "store_credit": CustomerStoreCredit, + "structure_id": 4, + "suffix": "xyz789", + "taxvat": "abc123", + "team": CompanyTeam, + "telephone": "xyz789", + "wishlist_v2": Wishlist, + "wishlists": [Wishlist] } ``` -### CompanyUserCreateInput +### CustomerAddress -Defines the input schema for creating a company user. +Contains detailed information about a customer's billing or shipping address. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The company user's email address | -| `firstname` - [`String!`](#string) | The company user's first name. | -| `job_title` - [`String!`](#string) | The company user's job title or function. | -| `lastname` - [`String!`](#string) | The company user's last name. | -| `role_id` - [`ID!`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum!`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `target_id` - [`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!`](#string) | The company user's phone number. | +| Field Name | Description | +|------------|-------------| +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the customer's default shipping address. | +| `extension_attributes` - [`[CustomerAddressAttribute]`](#customeraddressattribute) | Contains any extension attributes for the address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the shipping/billing address. | +| `id` - [`Int`](#int) | The ID of a `CustomerAddress` object. *(Deprecated: Use `uid` instead.)* | +| `lastname` - [`String`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegion`](#customeraddressregion) | An object containing the region name, region code, and region ID. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `uid` - [`ID`](#id) | The unique ID for a `CustomerAddress` object. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "email": "xyz789", - "firstname": "abc123", - "job_title": "abc123", + "city": "xyz789", + "company": "xyz789", + "country_code": "AF", + "custom_attributesV2": [AttributeValueInterface], + "default_billing": false, + "default_shipping": true, + "extension_attributes": [CustomerAddressAttribute], + "fax": "abc123", + "firstname": "xyz789", + "id": 123, "lastname": "xyz789", - "role_id": "4", - "status": "ACTIVE", - "target_id": 4, - "telephone": "xyz789" + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CustomerAddressRegion, + "region_id": 987, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": "4", + "vat_id": "xyz789" } ``` -### CompanyUserStatusEnum +### CustomerAddressAttribute -Defines the list of company user status values. +Specifies the attribute code and value of a customer address attribute. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ACTIVE` | Only active users. | -| `INACTIVE` | Only inactive users. | +| `attribute_code` - [`String`](#string) | The name assigned to the customer address attribute. | +| `value` - [`String`](#string) | The value assigned to the customer address attribute. | #### Example ```json -""ACTIVE"" +{ + "attribute_code": "xyz789", + "value": "xyz789" +} ``` -### CompanyUserUpdateInput +### CustomerAddressInput -Defines the input schema for updating a company user. +Contains details about a billing or shipping address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `email` - [`String`](#string) | The company user's email address. | -| `firstname` - [`String`](#string) | The company user's first name. | -| `id` - [`ID!`](#id) | The unique ID of a `Customer` object. | -| `job_title` - [`String`](#string) | The company user's job title or function. | -| `lastname` - [`String`](#string) | The company user's last name. | -| `role_id` - [`ID`](#id) | The unique ID for a `CompanyRole` object. | -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | Indicates whether the company user is ACTIVE or INACTIVE. | -| `telephone` - [`String`](#string) | The company user's phone number. | +| `city` - [`String`](#string) | The customer's city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `custom_attributesV2` - [`[AttributeValueInput]`](#attributevalueinput) | Custom attributes assigned to the customer address. | +| `default_billing` - [`Boolean`](#boolean) | Indicates whether the address is the default billing address. | +| `default_shipping` - [`Boolean`](#boolean) | Indicates whether the address is the default shipping address. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String`](#string) | The first name of the person associated with the billing/shipping address. | +| `lastname` - [`String`](#string) | The family name of the person associated with the billing/shipping address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "email": "abc123", + "city": "xyz789", + "company": "abc123", + "country_code": "AF", + "custom_attributesV2": [AttributeValueInput], + "default_billing": false, + "default_shipping": true, + "fax": "xyz789", "firstname": "xyz789", - "id": "4", - "job_title": "abc123", - "lastname": "abc123", - "role_id": 4, - "status": "ACTIVE", - "telephone": "abc123" + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", + "region": CustomerAddressRegionInput, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "xyz789" } ``` -### CompanyUsers +### CustomerAddressRegion -Contains details about company users. +Defines the customer's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[Customer]!`](#customer) | An array of `CompanyUser` objects that match the specified filter criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int!`](#int) | The number of objects returned. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "items": [Customer], - "page_info": SearchResultPageInfo, - "total_count": 123 + "region": "xyz789", + "region_code": "abc123", + "region_id": 987 } ``` -### CompanyUsersFilterInput +### CustomerAddressRegionInput -Defines the filter for returning a list of company users. +Defines the customer's state or province. #### Input Fields | Input Field | Description | |-------------|-------------| -| `status` - [`CompanyUserStatusEnum`](#companyuserstatusenum) | The activity status to filter on. | +| `region` - [`String`](#string) | The state or province name. | +| `region_code` - [`String`](#string) | The address region code. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json -{"status": "ACTIVE"} +{ + "region": "xyz789", + "region_code": "abc123", + "region_id": 123 +} ``` -### ComparableAttribute - -Contains an attribute code that is used for product comparisons. +### CustomerAddresses #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | An attribute code that is enabled for product comparisons. | -| `label` - [`String!`](#string) | The label of the attribute code. | +| `items` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer addresses. | #### Example ```json { - "code": "abc123", - "label": "xyz789" + "items": [CustomerAddress], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### ComparableItem +### CustomerAttributeMetadata -Defines an object used to iterate through items for product comparisons. +Customer attribute metadata. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ProductAttribute]!`](#productattribute) | An array of product attributes that can be used to compare products. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a product in a compare list. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `uid` - [`ID!`](#id) | The unique ID of an item in a compare list. | +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | #### Example ```json { - "attributes": [ProductAttribute], - "product": ProductInterface, - "uid": 4 + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "abc123", + "frontend_input": "BOOLEAN", + "input_filter": "NONE", + "is_required": false, + "is_unique": true, + "label": "xyz789", + "multiline_count": 123, + "options": [CustomAttributeOptionInterface], + "sort_order": 987, + "validate_rules": [ValidationRule] } ``` -### CompareList +### CustomerCreateInput -Contains iterable information such as the array of items, the count, and attributes that represent the compare list. +An input object for creating a customer. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `attributes` - [`[ComparableAttribute]`](#comparableattribute) | An array of attributes that can be used for comparing products. | -| `item_count` - [`Int!`](#int) | The number of items in the compare list. | -| `items` - [`[ComparableItem]`](#comparableitem) | An array of products to compare. | -| `uid` - [`ID!`](#id) | The unique ID assigned to the compare list. | +| Input Field | Description | +|-------------|-------------| +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `email` - [`String!`](#string) | The customer's email address. | +| `firstname` - [`String!`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String!`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `password` - [`String`](#string) | The customer's password. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "attributes": [ComparableAttribute], - "item_count": 123, - "items": [ComparableItem], - "uid": 4 + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "xyz789", + "email": "abc123", + "firstname": "xyz789", + "gender": 123, + "is_subscribed": false, + "lastname": "abc123", + "middlename": "abc123", + "password": "abc123", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "abc123" } ``` -### CompleteOrderInput +### CustomerDownloadableProduct -Update the quote and complete the order +Contains details about a single downloadable product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | +| Field Name | Description | +|------------|-------------| +| `date` - [`String`](#string) | The date and time the purchase was made. | +| `download_url` - [`String`](#string) | The fully qualified URL to the download file. | +| `order_increment_id` - [`String`](#string) | The unique ID assigned to the item. | +| `remaining_downloads` - [`String`](#string) | The remaining number of times the customer can download the product. | +| `status` - [`String`](#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | #### Example ```json { - "cartId": "abc123", - "id": "xyz789" + "date": "xyz789", + "download_url": "abc123", + "order_increment_id": "abc123", + "remaining_downloads": "xyz789", + "status": "xyz789" } ``` -### ComplexProductView +### CustomerDownloadableProducts -Represents all product types, except simple products. Complex product prices are returned as a price range, because price values can vary based on selected options. +Contains a list of downloadable products. #### Fields | Field Name | Description | |------------|-------------| -| `addToCartAllowed` - [`Boolean`](#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | -| `inStock` - [`Boolean`](#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | -| `lowStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the Only X Left threshold. *(Deprecated: This field is deprecated and will be removed.)* | -| `attributes` - [`[ProductViewAttribute]`](#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | -| `description` - [`String`](#string) | The detailed description of the product. | -| `id` - [`ID!`](#id) | The product ID, generated as a composite key, unique per locale. | -| `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image` or `swatch`. | -| `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | -| `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | -| `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | -| `metaKeyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `metaTitle` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | Product name. | -| `inputOptions` - [`[ProductViewInputOption]`](#productviewinputoption) | A list of input options. *(Deprecated: This field is deprecated and will be removed.)* | -| `options` - [`[ProductViewOption]`](#productviewoption) | A list of selectable options. | -| `priceRange` - [`ProductViewPriceRange`](#productviewpricerange) | A range of possible prices for a complex product. | -| `shortDescription` - [`String`](#string) | A summary of the product. | -| `sku` - [`String`](#string) | A unique code used for identification of a product. | -| `externalId` - [`String`](#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | -| `url` - [`String`](#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | -| `urlKey` - [`String`](#string) | The URL key of the product. | -| `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. Links are used to navigate from one product to another. | -| `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | -| `visibility` - [`String`](#string) | Visibility setting of the product | +| `items` - [`[CustomerDownloadableProduct]`](#customerdownloadableproduct) | An array of purchased downloadable items. | #### Example - -```json -{ - "addToCartAllowed": false, - "inStock": false, - "lowStock": true, - "attributes": [ProductViewAttribute], - "description": "xyz789", - "id": 4, - "images": [ProductViewImage], - "videos": [ProductViewVideo], - "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", - "metaTitle": "xyz789", - "name": "abc123", - "inputOptions": [ProductViewInputOption], - "options": [ProductViewOption], - "priceRange": ProductViewPriceRange, - "shortDescription": "abc123", - "sku": "abc123", - "externalId": "abc123", - "url": "xyz789", - "urlKey": "abc123", - "links": [ProductViewLink], - "queryType": "abc123", - "visibility": "abc123" -} + +```json +{"items": [CustomerDownloadableProduct]} ``` -### ComplexTextValue +### CustomerGroupStorefront + +Data of customer group. #### Fields | Field Name | Description | |------------|-------------| -| `html` - [`String!`](#string) | Text that can contain HTML tags. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomerGroup` object. | #### Example ```json -{"html": "abc123"} +{"uid": "4"} ``` -### ConditionInput +### CustomerOrder + +Contains details about each of the customer's orders. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `admin_assisted_order` - [`Int`](#int) | Admin user id when the order was placed with assistance (Login as Customer); null if not assisted. | +| `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | +| `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | +| `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | +| `billing_address` - [`OrderAddress`](#orderaddress) | The billing address for the order. | +| `carrier` - [`String`](#string) | The shipping carrier for the order delivery. | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments about the order. | +| `credit_memos` - [`[CreditMemo]`](#creditmemo) | A list of credit memos. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order | +| `customer_info` - [`OrderCustomerInfo!`](#ordercustomerinfo) | Returns customer information from order. | +| `email` - [`String`](#string) | Order customer email. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the order | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a gift receipt for the order. | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order. | +| `id` - [`ID!`](#id) | The unique ID for a `CustomerOrder` object. | +| `invoices` - [`[Invoice]!`](#invoice) | A list of invoices for the order. | +| `is_virtual` - [`Boolean!`](#boolean) | `TRUE` if the order is virtual | +| `items` - [`[OrderItemInterface]`](#orderiteminterface) | An array containing the items purchased in this order. | +| `items_eligible_for_return` - [`[OrderItemInterface]`](#orderiteminterface) | A list of order items eligible to be in a return request. | +| `negotiable_quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote associated with this order. | +| `number` - [`String!`](#string) | The order number. | +| `order_date` - [`String!`](#string) | The date the order was placed. | +| `order_status_change_date` - [`String!`](#string) | The date the order status was last updated. | +| `payment_methods` - [`[OrderPaymentMethod]`](#orderpaymentmethod) | Payment details for the order. | +| `printed_card_included` - [`Boolean!`](#boolean) | Indicates whether the customer requested a printed card for the order. | +| `returns` - [`Returns`](#returns) | Return requests associated with this order. | +| `shipments` - [`[OrderShipment]`](#ordershipment) | A list of shipments for the order. | +| `shipping_address` - [`OrderAddress`](#orderaddress) | The shipping address for the order. | +| `shipping_method` - [`String`](#string) | The delivery method for the order. | +| `status` - [`String!`](#string) | The current status of the order. | +| `token` - [`String!`](#string) | The token that can be used to retrieve the order using order query. | +| `total` - [`OrderTotal`](#ordertotal) | Details about the calculated totals for this order. | + +#### Example + +```json +{ + "admin_assisted_order": 123, + "applied_coupons": [AppliedCoupon], + "applied_gift_cards": [ApplyGiftCardToOrder], + "available_actions": ["REORDER"], + "billing_address": OrderAddress, + "carrier": "abc123", + "comments": [SalesCommentItem], + "credit_memos": [CreditMemo], + "custom_attributes": [CustomAttribute], + "customer_info": OrderCustomerInfo, + "email": "abc123", + "gift_message": GiftMessage, + "gift_receipt_included": true, + "gift_wrapping": GiftWrapping, + "id": 4, + "invoices": [Invoice], + "is_virtual": false, + "items": [OrderItemInterface], + "items_eligible_for_return": [OrderItemInterface], + "negotiable_quote": NegotiableQuote, + "number": "abc123", + "order_date": "abc123", + "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", + "total": OrderTotal +} +``` + + + +### CustomerOrderSortInput + +CustomerOrderSortInput specifies the field to use for sorting search results and indicates whether the results are sorted in ascending or descending order. #### Input Fields | Input Field | Description | |-------------|-------------| -| `field` - [`Field`](#field) | | -| `operator` - [`OperatorInput`](#operatorinput) | | -| `enabled` - [`Boolean`](#boolean) | | +| `sort_direction` - [`SortEnum!`](#sortenum) | This enumeration indicates whether to return results in ascending or descending order | +| `sort_field` - [`CustomerOrderSortableField!`](#customerordersortablefield) | Specifies the field to use for sorting | #### Example ```json -{ - "field": "UNKNOWN_FIELD", - "operator": OperatorInput, - "enabled": false -} +{"sort_direction": "ASC", "sort_field": "NUMBER"} ``` -### ConfigurableAttributeOption +### CustomerOrderSortableField -Contains details about a configurable product attribute option. +Specifies the field to use for sorting -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `code` - [`String`](#string) | The ID assigned to the attribute. | -| `label` - [`String`](#string) | A string that describes the configurable attribute option. | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableAttributeOption` object. | -| `value_index` - [`Int`](#int) | A unique index number assigned to the configurable product option. | +| `NUMBER` | Sorts customer orders by number | +| `CREATED_AT` | Sorts customer orders by created_at field | #### Example ```json -{ - "code": "xyz789", - "label": "abc123", - "uid": 4, - "value_index": 123 -} +""NUMBER"" ``` -### ConfigurableCartItem +### CustomerOrders -An implementation for configurable product cart items. +The collection of orders that match the conditions defined in the filter. #### Fields | Field Name | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | -| `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | -| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `date_of_first_order` - [`String`](#string) | Date of the first order placed in the store | +| `items` - [`[CustomerOrder]!`](#customerorder) | An array of customer orders. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int`](#int) | The total count of customer orders. | #### Example ```json { - "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "custom_attributes": [CustomAttribute], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "is_available": true, - "is_salable": 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": 123.45, - "uid": 4 + "date_of_first_order": "xyz789", + "items": [CustomerOrder], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### ConfigurableOptionAvailableForSelection +### CustomerOrdersFilterInput -Describes configurable options that have been selected and can be selected as a result of the previous selections. +Identifies the filter to use for filtering orders. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `option_value_uids` - [`[ID]!`](#id) | An array of selectable option value IDs. | +| Input Field | Description | +|-------------|-------------| +| `grand_total` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order base grand total value. | +| `number` - [`FilterStringTypeInput`](#filterstringtypeinput) | Filters by order number. | +| `order_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filters by order created_at time. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filters by order status. | #### Example ```json { - "attribute_code": "abc123", - "option_value_uids": [4] + "grand_total": FilterRangeTypeInput, + "number": FilterStringTypeInput, + "order_date": FilterRangeTypeInput, + "status": FilterEqualTypeInput } ``` -### ConfigurableOrderItem +### CustomerOutput + +Contains details about a newly-created or updated customer. #### Fields | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `parent_sku` - [`String`](#string) | The SKU of parent product. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +| `customer` - [`Customer!`](#customer) | Customer details after creating or updating a customer. | #### Example ```json -{ - "custom_attributes": [CustomAttribute], - "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": "xyz789", - "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, - "quantity_returned": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "xyz789" -} +{"customer": Customer} ``` -### ConfigurableProduct +### CustomerPaymentTokens -Defines basic features of a configurable product and its simple product variants. +Contains payment tokens stored in the customer's vault. #### Fields | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `configurable_options` - [`[ConfigurableProductOptions]`](#configurableproductoptions) | An array of options for the configurable product. | -| `configurable_product_options_selection` - [`ConfigurableProductOptionsSelection`](#configurableproductoptionsselection) | An array of media gallery items and other details about selected configurable product options as well as details about remaining selectable options. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `variants` - [`[ConfigurableVariant]`](#configurablevariant) | An array of simple product variants. | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `items` - [`[PaymentToken]!`](#paymenttoken) | An array of payment tokens. | #### Example ```json -{ - "canonical_url": "abc123", - "categories": [CategoryInterface], - "configurable_options": [ConfigurableProductOptions], - "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 123, - "max_sale_qty": 987.65, - "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", - "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options": [CustomizableOptionInterface], - "options_container": "abc123", - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 987.65, - "related_products": [ProductInterface], - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "abc123", - "thumbnail": ProductImage, - "uid": "4", - "upsell_products": [ProductInterface], - "url_key": "xyz789", - "variants": [ConfigurableVariant], - "weight": 123.45 -} +{"items": [PaymentToken]} ``` -### ConfigurableProductOption +### CustomerSegmentStorefront -Contains details about configurable product options. +Customer segment details #### Fields -| Field Name | Description | -|------------|-------------| -| `attribute_code` - [`String!`](#string) | An attribute code that uniquely identifies a configurable option. | -| `label` - [`String!`](#string) | The display name of the option. | -| `uid` - [`ID!`](#id) | The unique ID of the configurable option. | -| `values` - [`[ConfigurableProductOptionValue]`](#configurableproductoptionvalue) | An array of values that are applicable for this option. | - +| Field Name | Description | +|------------|-------------| +| `uid` - [`ID!`](#id) | The unique ID for a `CustomerSegment` object. | + #### Example ```json -{ - "attribute_code": "abc123", - "label": "abc123", - "uid": "4", - "values": [ConfigurableProductOptionValue] -} +{"uid": 4} ``` -### ConfigurableProductOptionValue +### CustomerStoreCredit -Defines a value for a configurable product option. +Contains store credit information with balance and history. #### Fields | Field Name | Description | |------------|-------------| -| `is_available` - [`Boolean!`](#boolean) | Indicates whether the product is available with this selected option. | -| `is_use_default` - [`Boolean!`](#boolean) | Indicates whether the value is the default. | -| `label` - [`String!`](#string) | The display name of the value. | -| `swatch` - [`SwatchDataInterface`](#swatchdatainterface) | The URL assigned to the thumbnail of the swatch image. | -| `uid` - [`ID!`](#id) | The unique ID of the value. | +| `balance_history` - [`CustomerStoreCreditHistory`](#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. | +| `current_balance` - [`Money`](#money) | The current balance of store credit. | +| `enabled` - [`Boolean`](#boolean) | Indicates whether store credits are enabled. If the feature is disabled, then the balance will not be returned. | #### Example ```json { - "is_available": true, - "is_use_default": false, - "label": "abc123", - "swatch": SwatchDataInterface, - "uid": 4 + "balance_history": CustomerStoreCreditHistory, + "current_balance": Money, + "enabled": false } ``` -### ConfigurableProductOptions +### CustomerStoreCreditHistory -Defines configurable attributes for the specified product. +Lists changes to the amount of store credit available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | A string that identifies the attribute. | -| `attribute_uid` - [`ID!`](#id) | The unique ID for an `Attribute` object. | -| `label` - [`String`](#string) | A displayed string that describes the configurable product option. | -| `position` - [`Int`](#int) | A number that indicates the order in which the attribute is displayed. | -| `uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `use_default` - [`Boolean`](#boolean) | Indicates whether the option is the default. | -| `values` - [`[ConfigurableProductOptionsValues]`](#configurableproductoptionsvalues) | An array that defines the `value_index` codes assigned to the configurable product. | +| `items` - [`[CustomerStoreCreditHistoryItem]`](#customerstorecredithistoryitem) | An array containing information about changes to the store credit available to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Metadata for pagination rendering. | +| `total_count` - [`Int`](#int) | The number of items returned. | #### Example ```json { - "attribute_code": "abc123", - "attribute_uid": 4, - "label": "abc123", - "position": 987, - "uid": "4", - "use_default": true, - "values": [ConfigurableProductOptionsValues] + "items": [CustomerStoreCreditHistoryItem], + "page_info": SearchResultPageInfo, + "total_count": 987 } ``` -### ConfigurableProductOptionsSelection +### CustomerStoreCreditHistoryItem -Contains metadata corresponding to the selected configurable options. +Contains store credit history information. #### Fields | Field Name | Description | |------------|-------------| -| `configurable_options` - [`[ConfigurableProductOption]`](#configurableproductoption) | An array of all possible configurable options. | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | Product images and videos corresponding to the specified configurable options selection. | -| `options_available_for_selection` - [`[ConfigurableOptionAvailableForSelection]`](#configurableoptionavailableforselection) | The configurable options available for further selection based on the current selection. | -| `variant` - [`SimpleProduct`](#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. | +| `action` - [`String`](#string) | The action that was made on the store credit. | +| `actual_balance` - [`Money`](#money) | The store credit available to the customer as a result of this action. | +| `balance_change` - [`Money`](#money) | The amount added to or subtracted from the store credit as a result of this action. | +| `date_time_changed` - [`String`](#string) | The date and time when the store credit change was made. | #### Example ```json { - "configurable_options": [ConfigurableProductOption], - "media_gallery": [MediaGalleryInterface], - "options_available_for_selection": [ - ConfigurableOptionAvailableForSelection - ], - "variant": SimpleProduct + "action": "xyz789", + "actual_balance": Money, + "balance_change": Money, + "date_time_changed": "xyz789" } ``` -### ConfigurableProductOptionsValues +### CustomerToken -Contains the index number assigned to a configurable product option. +Contains a customer authorization token. #### Fields | Field Name | Description | |------------|-------------| -| `default_label` - [`String`](#string) | The label of the product on the default store. | -| `label` - [`String`](#string) | The label of the product. | -| `store_label` - [`String`](#string) | The label of the product on the current store. | -| `swatch_data` - [`SwatchDataInterface`](#swatchdatainterface) | Swatch data for a configurable product option. | -| `uid` - [`ID`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `use_default_value` - [`Boolean`](#boolean) | Indicates whether to use the default_label. | +| `token` - [`String`](#string) | The customer authorization token. | #### Example ```json -{ - "default_label": "xyz789", - "label": "abc123", - "store_label": "xyz789", - "swatch_data": SwatchDataInterface, - "uid": "4", - "use_default_value": true -} +{"token": "abc123"} ``` -### ConfigurableRequisitionListItem +### CustomerUpdateInput -Contains details about configurable products added to a requisition list. +An input object for updating a customer. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | Selected configurable options for an item in the requisition list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | -| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | -| `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | +| Input Field | Description | +|-------------|-------------| +| `allow_remote_shopping_assistance` - [`Boolean`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The customer's custom attributes. | +| `date_of_birth` - [`String`](#string) | The customer's date of birth. | +| `firstname` - [`String`](#string) | The customer's first name. | +| `gender` - [`Int`](#int) | The customer's gender (Male - 1, Female - 2). | +| `is_subscribed` - [`Boolean`](#boolean) | Indicates whether the customer is subscribed to the company's newsletter. | +| `lastname` - [`String`](#string) | The customer's family name. | +| `middlename` - [`String`](#string) | The customer's middle name. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `taxvat` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "configurable_options": [SelectedConfigurableOption], - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "sku": "xyz789", - "uid": "4" + "allow_remote_shopping_assistance": true, + "custom_attributes": [AttributeValueInput], + "date_of_birth": "xyz789", + "firstname": "abc123", + "gender": 123, + "is_subscribed": true, + "lastname": "xyz789", + "middlename": "xyz789", + "prefix": "abc123", + "suffix": "abc123", + "taxvat": "xyz789" } ``` -### ConfigurableVariant +### CustomizableAreaOption -Contains all the simple product variants of a configurable product. +Contains information about a text area that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `attributes` - [`[ConfigurableAttributeOption]`](#configurableattributeoption) | An array of configurable attribute options. | -| `product` - [`SimpleProduct`](#simpleproduct) | An array of linked simple products. | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableAreaValue`](#customizableareavalue) | An object that defines a text area. | #### Example ```json { - "attributes": [ConfigurableAttributeOption], - "product": SimpleProduct + "product_sku": "xyz789", + "required": false, + "sort_order": 987, + "title": "abc123", + "uid": "4", + "value": CustomizableAreaValue } ``` -### ConfigurableWishlistItem +### CustomizableAreaValue -A configurable product wish list item. +Defines the price and sku of a product whose page contains a customized text area. #### Fields | Field Name | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `configurable_options` - [`[SelectedConfigurableOption]`](#selectedconfigurableoption) | An array of selected configurable options. | -| `configured_variant` - [`ProductInterface`](#productinterface) | Product details of the selected variant. The value is null if some options are not configured. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableAreaValue` object. | #### Example ```json { - "added_at": "xyz789", - "configurable_options": [SelectedConfigurableOption], - "configured_variant": ProductInterface, - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "product": ProductInterface, - "quantity": 987.65 + "max_characters": 123, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "uid": 4 } ``` -### ConfirmCancelOrderInput +### CustomizableCheckboxOption -#### Input Fields +Contains information about a set of checkbox values that are defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to cancel the order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableCheckboxValue]`](#customizablecheckboxvalue) | An array that defines a set of checkbox values. | #### Example ```json { - "confirmation_key": "abc123", - "order_id": "4" + "required": true, + "sort_order": 987, + "title": "xyz789", + "uid": "4", + "value": [CustomizableCheckboxValue] } ``` -### ConfirmEmailInput +### CustomizableCheckboxValue -Contains details about a customer email address to confirm. +Defines the price and sku of a product whose page contains a customized set of checkbox values. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | The key to confirm the email address. | -| `email` - [`String!`](#string) | The email address to be confirmed. | +| Field Name | Description | +|------------|-------------| +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the checkbox value is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableCheckboxValue` object. | #### Example ```json { - "confirmation_key": "abc123", - "email": "xyz789" + "option_type_id": 123, + "price": 123.45, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "abc123", + "uid": 4 } ``` -### ConfirmReturnInput +### CustomizableDateOption -#### Input Fields +Contains information about a date picker that is defined as part of a customizable option. -| Input Field | Description | -|-------------|-------------| -| `confirmation_key` - [`String!`](#string) | Confirmation Key to return order. | -| `order_id` - [`ID!`](#id) | The unique ID of an `Order` type. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableDateValue`](#customizabledatevalue) | An object that defines a date field in a customizable option. | #### Example ```json { - "confirmation_key": "xyz789", - "order_id": 4 + "product_sku": "xyz789", + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": "4", + "value": CustomizableDateValue } ``` -### ConfirmationStatusEnum +### CustomizableDateTypeEnum -List of account confirmation statuses. +Defines the customizable date type. #### Values | Enum Value | Description | |------------|-------------| -| `ACCOUNT_CONFIRMED` | Account confirmed | -| `ACCOUNT_CONFIRMATION_NOT_REQUIRED` | Account confirmation not required | +| `DATE` | | +| `DATE_TIME` | | +| `TIME` | | #### Example ```json -""ACCOUNT_CONFIRMED"" +""DATE"" ``` -### ContactUsInput +### CustomizableDateValue -#### Input Fields +Defines the price and sku of a product whose page contains a customized date picker. -| Input Field | Description | -|-------------|-------------| -| `comment` - [`String!`](#string) | The shopper's comment to the merchant. | -| `email` - [`String!`](#string) | The email address of the shopper. | -| `name` - [`String!`](#string) | The full name of the shopper. | -| `telephone` - [`String`](#string) | The shopper's telephone number. | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `type` - [`CustomizableDateTypeEnum`](#customizabledatetypeenum) | DATE, DATE_TIME or TIME | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDateValue` object. | #### Example ```json { - "comment": "xyz789", - "email": "xyz789", - "name": "abc123", - "telephone": "abc123" + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "type": "DATE", + "uid": 4 } ``` -### ContactUsOutput +### CustomizableDropDownOption -Contains the status of the request. +Contains information about a drop down menu that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `status` - [`Boolean!`](#boolean) | Indicates whether the request was successful. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableDropDownValue]`](#customizabledropdownvalue) | An array that defines the set of options for a drop down menu. | #### Example ```json -{"status": false} +{ + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": [CustomizableDropDownValue] +} ``` -### CopyItemsBetweenRequisitionListsInput +### CustomizableDropDownValue -An input object that defines the items in a requisition list to be copied. +Defines the price and sku of a product whose page contains a customized drop down menu. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products copied from one requisition list to another. | +| Field Name | Description | +|------------|-------------| +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableDropDownValue` object. | #### Example ```json -{"requisitionListItemUids": ["4"]} +{ + "option_type_id": 123, + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 123, + "title": "xyz789", + "uid": "4" +} ``` -### CopyItemsFromRequisitionListsOutput +### CustomizableFieldOption -Output of the request to copy items to the destination requisition list. +Contains information about a text field that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after the items were copied. | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFieldValue`](#customizablefieldvalue) | An object that defines a text field. | #### Example ```json -{"requisition_list": RequisitionList} +{ + "product_sku": "abc123", + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": 4, + "value": CustomizableFieldValue +} ``` -### CopyProductsBetweenWishlistsOutput +### CustomizableFieldValue -Contains the source and target wish lists after copying products. +Defines the price and sku of a product whose page contains a customized text field. #### Fields | Field Name | Description | |------------|-------------| -| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list containing the copied products. | -| `source_wishlist` - [`Wishlist!`](#wishlist) | The wish list that the products were copied from. | -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while copying products in a wish list. | +| `max_characters` - [`Int`](#int) | The maximum number of characters that can be entered for this customizable option. | +| `price` - [`Float`](#float) | The price of the custom value. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFieldValue` object. | #### Example ```json { - "destination_wishlist": Wishlist, - "source_wishlist": Wishlist, - "user_errors": [WishListUserInputError] + "max_characters": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "xyz789", + "uid": 4 } ``` -### Country +### CustomizableFileOption + +Contains information about a file picker that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `available_regions` - [`[Region]`](#region) | An array of regions within a particular country. | -| `full_name_english` - [`String`](#string) | The name of the country in English. | -| `full_name_locale` - [`String`](#string) | The name of the country in the current locale. | -| `id` - [`String`](#string) | The unique ID for a `Country` object. | -| `three_letter_abbreviation` - [`String`](#string) | The three-letter abbreviation of the country, such as USA. | -| `two_letter_abbreviation` - [`String`](#string) | The two-letter abbreviation of the country, such as US. | +| `product_sku` - [`String`](#string) | The Stock Keeping Unit of the base product. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`CustomizableFileValue`](#customizablefilevalue) | An object that defines a file value. | #### Example ```json { - "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "xyz789", - "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "product_sku": "xyz789", + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": 4, + "value": CustomizableFileValue } ``` - - -### CountryCodeEnum - -The list of country codes. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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 | - + + +### CustomizableFileValue + +Defines the price and sku of a product whose page contains a customized file picker. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `file_extension` - [`String`](#string) | The file extension to accept. | +| `image_size_x` - [`Int`](#int) | The maximum width of an image. | +| `image_size_y` - [`Int`](#int) | The maximum height of an image. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableFileValue` object. | + #### Example ```json -""AF"" +{ + "file_extension": "xyz789", + "image_size_x": 123, + "image_size_y": 123, + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "uid": "4" +} ``` -### CreateCompanyOutput +### CustomizableMultipleOption -Contains the response to the request to create a company. +Contains information about a multiselect that is defined as part of a customizable option. #### Fields | Field Name | Description | |------------|-------------| -| `company` - [`Company!`](#company) | The new company instance. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableMultipleValue]`](#customizablemultiplevalue) | An array that defines the set of options for a multiselect. | #### Example ```json -{"company": Company} +{ + "required": false, + "sort_order": 123, + "title": "abc123", + "uid": "4", + "value": [CustomizableMultipleValue] +} ``` -### CreateCompanyRoleOutput +### CustomizableMultipleValue -Contains the response to the request to create a company role. +Defines the price and sku of a product whose page contains a customized multiselect. #### Fields | Field Name | Description | |------------|-------------| -| `role` - [`CompanyRole!`](#companyrole) | The new company role instance. | +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableMultipleValue` object. | #### Example ```json -{"role": CompanyRole} +{ + "option_type_id": 987, + "price": 123.45, + "price_type": "FIXED", + "sku": "xyz789", + "sort_order": 987, + "title": "abc123", + "uid": 4 +} ``` -### CreateCompanyTeamOutput +### CustomizableOptionInput -Contains the response to the request to create a company team. +Defines a customizable option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `uid` - [`ID`](#id) | The unique ID for a `CartItemInterface` object. | +| `value_string` - [`String!`](#string) | The string value of the option. | + +#### Example + +```json +{"uid": 4, "value_string": "xyz789"} +``` + + + +### CustomizableOptionInterface + +Contains basic information about a customizable option. It can be implemented by several types of configurable options. #### Fields | Field Name | Description | |------------|-------------| -| `team` - [`CompanyTeam!`](#companyteam) | The new company team instance. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | + +#### Possible Types + +| CustomizableOptionInterface Types | +|----------------| +| [`CustomizableAreaOption`](#customizableareaoption) | +| [`CustomizableCheckboxOption`](#customizablecheckboxoption) | +| [`CustomizableDateOption`](#customizabledateoption) | +| [`CustomizableDropDownOption`](#customizabledropdownoption) | +| [`CustomizableFieldOption`](#customizablefieldoption) | +| [`CustomizableFileOption`](#customizablefileoption) | +| [`CustomizableMultipleOption`](#customizablemultipleoption) | +| [`CustomizableRadioOption`](#customizableradiooption) | #### Example ```json -{"team": CompanyTeam} +{ + "required": true, + "sort_order": 123, + "title": "abc123", + "uid": 4 +} ``` -### CreateCompanyUserOutput +### CustomizableProductInterface -Contains the response to the request to create a company user. +Contains information about customizable product options. #### Fields | Field Name | Description | |------------|-------------| -| `user` - [`Customer!`](#customer) | The new company user instance. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | + +#### Possible Types + +| CustomizableProductInterface Types | +|----------------| +| [`BundleProduct`](#bundleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`VirtualProduct`](#virtualproduct) | #### Example ```json -{"user": Customer} +{"options": [CustomizableOptionInterface]} ``` -### CreateCompareListInput +### CustomizableRadioOption -Contains an array of product IDs to use for creating a compare list. +Contains information about a set of radio buttons that are defined as part of a customizable option. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]`](#id) | An array of product IDs to add to the compare list. | +| Field Name | Description | +|------------|-------------| +| `required` - [`Boolean`](#boolean) | Indicates whether the option is required. | +| `sort_order` - [`Int`](#int) | The order in which the option is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object. | +| `value` - [`[CustomizableRadioValue]`](#customizableradiovalue) | An array that defines a set of radio buttons. | #### Example ```json -{"products": [4]} +{ + "required": false, + "sort_order": 987, + "title": "xyz789", + "uid": 4, + "value": [CustomizableRadioValue] +} ``` -### CreateGiftRegistryInput +### CustomizableRadioValue -Defines a new gift registry. +Defines the price and sku of a product whose page contains a customized set of radio buttons. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `dynamic_attributes` - [`[GiftRegistryDynamicAttributeInput]`](#giftregistrydynamicattributeinput) | Additional attributes specified as a code-value pair. | -| `event_name` - [`String!`](#string) | The name of the event. | -| `gift_registry_type_uid` - [`ID!`](#id) | The ID of the selected event type. | -| `message` - [`String!`](#string) | A message describing the event. | -| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | Indicates whether the registry is PRIVATE or PUBLIC. | -| `registrants` - [`[AddGiftRegistryRegistrantInput]!`](#addgiftregistryregistrantinput) | The list of people who receive notifications about the registry. | -| `shipping_address` - [`GiftRegistryShippingAddressInput`](#giftregistryshippingaddressinput) | The shipping address for all gift registry items. | -| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | Indicates whether the registry is ACTIVE or INACTIVE. | +| Field Name | Description | +|------------|-------------| +| `option_type_id` - [`Int`](#int) | The ID assigned to the value. | +| `price` - [`Float`](#float) | The price assigned to this option. | +| `price_type` - [`PriceTypeEnum`](#pricetypeenum) | FIXED, PERCENT, or DYNAMIC. | +| `sku` - [`String`](#string) | The Stock Keeping Unit for this option. | +| `sort_order` - [`Int`](#int) | The order in which the radio button is displayed. | +| `title` - [`String`](#string) | The display name for this option. | +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableRadioValue` object. | #### Example ```json { - "dynamic_attributes": [ - GiftRegistryDynamicAttributeInput - ], - "event_name": "xyz789", - "gift_registry_type_uid": "4", - "message": "abc123", - "privacy_settings": "PRIVATE", - "registrants": [AddGiftRegistryRegistrantInput], - "shipping_address": GiftRegistryShippingAddressInput, - "status": "ACTIVE" + "option_type_id": 987, + "price": 987.65, + "price_type": "FIXED", + "sku": "abc123", + "sort_order": 987, + "title": "xyz789", + "uid": 4 } ``` -### CreateGiftRegistryOutput +### DateTime -Contains the results of a request to create a gift registry. +A slightly refined version of RFC-3339 compliant DateTime Scalar + +#### Example + +```json +"2007-12-03T10:15:30Z" +``` + + + +### DeleteCompanyRoleOutput + +Contains the response to the request to delete the company role. #### Fields | Field Name | Description | |------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The newly-created gift registry. | +| `success` - [`Boolean!`](#boolean) | SIndicates whether the company role has been deleted successfully. | #### Example ```json -{"gift_registry": GiftRegistry} +{"success": true} ``` -### CreateGuestCartInput +### DeleteCompanyTeamOutput -#### Input Fields +Contains the status of the request to delete a company team. -| Input Field | Description | -|-------------|-------------| -| `cart_uid` - [`ID`](#id) | Optional client-generated ID | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the delete operation succeeded. | #### Example ```json -{"cart_uid": 4} +{"success": true} ``` -### CreateGuestCartOutput +### DeleteCompanyUserOutput + +Contains the response to the request to delete the company user. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart`](#cart) | The newly created cart. | +| `success` - [`Boolean!`](#boolean) | Indicates whether the company user has been deactivated successfully. | #### Example ```json -{"cart": Cart} +{"success": true} ``` -### CreatePaymentOrderInput +### DeleteCompareListOutput -Contains payment order details that are used while processing the payment order +Contains the results of the request to delete a compare list. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `location` - [`PaymentLocation!`](#paymentlocation) | Defines the origin location for that payment request | -| `methodCode` - [`String!`](#string) | The code for the payment method used in the order | -| `paymentSource` - [`String!`](#string) | The identifiable payment source for the payment method | -| `vaultIntent` - [`Boolean`](#boolean) | Indicates whether the payment information should be vaulted | +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | Indicates whether the compare list was successfully deleted. | #### Example ```json -{ - "cartId": "abc123", - "location": "PRODUCT_DETAIL", - "methodCode": "xyz789", - "paymentSource": "xyz789", - "vaultIntent": false -} +{"result": false} ``` -### CreatePaymentOrderOutput +### DeleteNegotiableQuoteError -Contains payment order details that are used while processing the payment order +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | +| [`InternalError`](#internalerror) | + +#### Example + +```json +NegotiableQuoteInvalidStateError +``` + + + +### DeleteNegotiableQuoteOperationFailure + +Contains details about a failed delete operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](#float) | The amount of the payment order | -| `currency_code` - [`String`](#string) | The currency of the payment order | -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `status` - [`String`](#string) | The status of the payment order | +| `errors` - [`[DeleteNegotiableQuoteError]!`](#deletenegotiablequoteerror) | | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "amount": 123.45, - "currency_code": "xyz789", - "id": "abc123", - "mp_order_id": "xyz789", - "status": "xyz789" + "errors": [NegotiableQuoteInvalidStateError], + "quote_uid": 4 } ``` -### CreatePurchaseOrderApprovalRuleConditionAmountInput +### DeleteNegotiableQuoteOperationResult -Specifies the amount and currency to evaluate. +#### Types + +| Union Types | +|-------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| [`DeleteNegotiableQuoteOperationFailure`](#deletenegotiablequoteoperationfailure) | + +#### Example + +```json +NegotiableQuoteUidOperationSuccess +``` + + + +### DeleteNegotiableQuoteTemplateInput + +Specifies the quote template id of the quote template to delete #### Input Fields | Input Field | Description | |-------------|-------------| -| `currency` - [`CurrencyEnum!`](#currencyenum) | Purchase order approval rule condition amount currency. | -| `value` - [`Float!`](#float) | Purchase order approval rule condition amount value. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"currency": "AFN", "value": 123.45} +{"template_id": "4"} ``` -### CreatePurchaseOrderApprovalRuleConditionInput - -Defines a set of conditions that apply to a rule. +### DeleteNegotiableQuotesInput #### Input Fields | Input Field | Description | |-------------|-------------| -| `amount` - [`CreatePurchaseOrderApprovalRuleConditionAmountInput`](#createpurchaseorderapprovalruleconditionamountinput) | The amount to be compared in a purchase order approval rule. This field is mutually exclusive with condition quantity. | -| `attribute` - [`PurchaseOrderApprovalRuleType!`](#purchaseorderapprovalruletype) | The type of approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator!`](#purchaseorderapprovalruleconditionoperator) | Defines how to evaluate an amount or quantity in a purchase order. | -| `quantity` - [`Int`](#int) | The quantity to be compared in a purchase order approval rule. This field is mutually exclusive with condition amount. | +| `quote_uids` - [`[ID]!`](#id) | A list of unique IDs for `NegotiableQuote` objects to delete. | + +#### Example + +```json +{"quote_uids": [4]} +``` + + + +### DeleteNegotiableQuotesOutput + +Contains a list of undeleted negotiable quotes the company user can view. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `negotiable_quotes` - [`NegotiableQuotesOutput`](#negotiablequotesoutput) | A list of negotiable quotes that the customer can view | +| `operation_results` - [`[DeleteNegotiableQuoteOperationResult]!`](#deletenegotiablequoteoperationresult) | An array of deleted negotiable quote UIDs and details about any errors. | +| `result_status` - [`BatchMutationStatus!`](#batchmutationstatus) | The status of the request to delete one or more negotiable quotes. | #### Example ```json { - "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN", - "quantity": 987 + "negotiable_quotes": NegotiableQuotesOutput, + "operation_results": [ + NegotiableQuoteUidOperationSuccess + ], + "result_status": "SUCCESS" } ``` -### CreateRequisitionListInput +### DeletePaymentTokenOutput -An input object that identifies and describes a new requisition list. +Indicates whether the request succeeded and returns the remaining customer payment tokens. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `description` - [`String`](#string) | An optional description of the requisition list. | -| `name` - [`String!`](#string) | The name assigned to the requisition list. | +| Field Name | Description | +|------------|-------------| +| `customerPaymentTokens` - [`CustomerPaymentTokens`](#customerpaymenttokens) | A container for the customer's remaining payment tokens. | +| `result` - [`Boolean!`](#boolean) | Indicates whether the request succeeded. | #### Example ```json { - "description": "xyz789", - "name": "abc123" + "customerPaymentTokens": CustomerPaymentTokens, + "result": false } ``` -### CreateRequisitionListOutput +### DeletePurchaseOrderApprovalRuleError -Output of the request to create a requisition list. +Contains details about an error that occurred when deleting an approval rule . #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList`](#requisitionlist) | The created requisition list. | +| `message` - [`String`](#string) | The text of the error message. | +| `type` - [`DeletePurchaseOrderApprovalRuleErrorType`](#deletepurchaseorderapprovalruleerrortype) | The error type. | #### Example ```json -{"requisition_list": RequisitionList} +{"message": "xyz789", "type": "UNDEFINED"} ``` -### CreateVaultCardPaymentTokenInput - -Describe the variables needed to create a vault payment token +### DeletePurchaseOrderApprovalRuleErrorType -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `card_description` - [`String`](#string) | Description of the vaulted card | -| `setup_token_id` - [`String!`](#string) | The setup token obtained by the createVaultCardSetupToken endpoint | +| Enum Value | Description | +|------------|-------------| +| `UNDEFINED` | | +| `NOT_FOUND` | | #### Example ```json -{ - "card_description": "xyz789", - "setup_token_id": "abc123" -} +""UNDEFINED"" ``` -### CreateVaultCardPaymentTokenOutput +### DeletePurchaseOrderApprovalRuleInput -The vault token id and information about the payment source +Specifies the IDs of the approval rules to delete. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `payment_source` - [`PaymentSourceOutput!`](#paymentsourceoutput) | The payment source information | -| `vault_token_id` - [`String!`](#string) | The vault payment token information | +| Input Field | Description | +|-------------|-------------| +| `approval_rule_uids` - [`[ID]!`](#id) | An array of purchase order approval rule IDs. | #### Example ```json -{ - "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" -} +{"approval_rule_uids": [4]} ``` -### CreateVaultCardSetupTokenInput +### DeletePurchaseOrderApprovalRuleOutput -Describe the variables needed to create a vault card setup token +Contains any errors encountered while attempting to delete approval rules. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `setup_token` - [`VaultSetupTokenInput!`](#vaultsetuptokeninput) | The setup token information | -| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | The 3DS mode | +| Field Name | Description | +|------------|-------------| +| `errors` - [`[DeletePurchaseOrderApprovalRuleError]!`](#deletepurchaseorderapprovalruleerror) | An array of error messages encountered while performing the operation. | #### Example ```json -{ - "setup_token": VaultSetupTokenInput, - "three_ds_mode": "OFF" -} +{"errors": [DeletePurchaseOrderApprovalRuleError]} ``` -### CreateVaultCardSetupTokenOutput +### DeleteRequisitionListItemsOutput -The setup token id information +Output of the request to remove items from the requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `setup_token` - [`String!`](#string) | The setup token id | +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The requisition list after removing items. | #### Example ```json -{"setup_token": "xyz789"} +{"requisition_list": RequisitionList} ``` -### CreateWishlistInput +### DeleteRequisitionListOutput -Defines the name and visibility of a new wish list. +Indicates whether the request to delete the requisition list was successful. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `name` - [`String!`](#string) | The name of the new wish list. | -| `visibility` - [`WishlistVisibilityEnum!`](#wishlistvisibilityenum) | Indicates whether the wish list is public or private. | +| Field Name | Description | +|------------|-------------| +| `requisition_lists` - [`RequisitionLists`](#requisitionlists) | The customer's requisition lists after deleting a requisition list. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the request to delete the requisition list was successful. | #### Example ```json -{"name": "abc123", "visibility": "PUBLIC"} +{"requisition_lists": RequisitionLists, "status": true} ``` -### CreateWishlistOutput +### DeleteWishlistOutput -Contains the wish list. +Contains the status of the request to delete a wish list and an array of the customer's remaining wish lists. #### Fields | Field Name | Description | |------------|-------------| -| `wishlist` - [`Wishlist!`](#wishlist) | The newly-created wish list | +| `status` - [`Boolean!`](#boolean) | Indicates whether the wish list was deleted. | +| `wishlists` - [`[Wishlist]!`](#wishlist) | A list of undeleted wish lists. | #### Example ```json -{"wishlist": Wishlist} +{"status": true, "wishlists": [Wishlist]} ``` -### CreditMemo +### Discount -Contains credit memo details. +Specifies the discount type and value for quote line item. #### Fields | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the credit memo. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemo` object. | -| `items` - [`[CreditMemoItemInterface]`](#creditmemoiteminterface) | An array containing details about refunded items. | -| `number` - [`String!`](#string) | The sequential credit memo number. | -| `total` - [`CreditMemoTotal`](#creditmemototal) | Details about the total refunded amount. | +| `amount` - [`Money!`](#money) | The amount of the discount. | +| `applied_to` - [`CartDiscountType!`](#cartdiscounttype) | The type of the entity the discount is applied to. | +| `coupon` - [`AppliedCoupon`](#appliedcoupon) | The coupon related to the discount. | +| `is_discounting_locked` - [`Boolean`](#boolean) | Is quote discounting locked for line item. | +| `label` - [`String!`](#string) | A description of the discount. | +| `type` - [`String`](#string) | Quote line item discount type. Values: 1 = PERCENTAGE_DISCOUNT; 2 = AMOUNT_DISCOUNT; 3 = PROPOSED_TOTAL. | +| `value` - [`Float`](#float) | Quote line item discount value. | #### Example ```json { - "comments": [SalesCommentItem], - "custom_attributes": [CustomAttribute], - "id": 4, - "items": [CreditMemoItemInterface], - "number": "abc123", - "total": CreditMemoTotal + "amount": Money, + "applied_to": "ITEM", + "coupon": AppliedCoupon, + "is_discounting_locked": false, + "label": "xyz789", + "type": "xyz789", + "value": 987.65 } ``` -### CreditMemoCustomAttributesInput +### DownloadableCartItem -Defines a credit memo item's custom attributes. +An implementation for downloadable product cart items. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `credit_memo_id` - [`String!`](#string) | The credit memo ID. | -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for the credit memo. | +| Field Name | Description | +|------------|-------------| +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of the selected downloadable product. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | #### Example ```json { - "credit_memo_id": "abc123", - "custom_attributes": [CustomAttributeInput] + "backorder_message": "xyz789", + "custom_attributes": [CustomAttribute], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "is_available": false, + "is_salable": true, + "links": [DownloadableProductLinks], + "max_qty": 123.45, + "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" } ``` -### CreditMemoItem +### DownloadableCreditMemoItem + +Defines downloadable product options for `CreditMemoItemInterface`. #### Fields @@ -6508,6 +6589,7 @@ Defines a credit memo item's custom attributes. |------------|-------------| | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | | `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are refunded from the downloadable product. | | `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | | `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | | `product_name` - [`String`](#string) | The name of the base product. | @@ -6521,66 +6603,35 @@ Defines a credit memo item's custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "downloadable_links": [DownloadableItemsLinks], + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 987.65 } ``` -### CreditMemoItemCustomAttributesInput - -Defines a credit memo's custom attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `credit_memo_id` - [`String!`](#string) | The credit memo ID. | -| `credit_memo_item_id` - [`String!`](#string) | The credit memo item ID. | -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for the credit memo item. | - -#### Example - -```json -{ - "credit_memo_id": "abc123", - "credit_memo_item_id": "xyz789", - "custom_attributes": [CustomAttributeInput] -} -``` - - - -### CreditMemoItemInterface +### DownloadableInvoiceItem -Credit memo item details. +Defines downloadable product options for `InvoiceItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | -| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | -| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are invoiced from the downloadable product. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | | `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | | `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | - -#### Possible Types - -| CreditMemoItemInterface Types | -|----------------| -| [`BundleCreditMemoItem`](#bundlecreditmemoitem) | -| [`CreditMemoItem`](#creditmemoitem) | -| [`DownloadableCreditMemoItem`](#downloadablecreditmemoitem) | -| [`GiftCardCreditMemoItem`](#giftcardcreditmemoitem) | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | #### Example @@ -6588,476 +6639,633 @@ Credit memo item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], + "downloadable_links": [DownloadableItemsLinks], "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_invoiced": 987.65 } ``` -### CreditMemoOutput +### DownloadableItemsLinks -Contains details about the credit memo after adding custom attributes to it. +Defines characteristics of the links for downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `credit_memo` - [`CreditMemo!`](#creditmemo) | The custom attributes to credit memo have been added. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableItemsLinks` object. | #### Example ```json -{"credit_memo": CreditMemo} +{ + "sort_order": 987, + "title": "abc123", + "uid": "4" +} ``` -### CreditMemoTotal +### DownloadableOrderItem -Contains credit memo price details. +Defines downloadable product options for `OrderItemInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `adjustment` - [`Money!`](#money) | An adjustment manually applied to the order. | -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the credit memo. | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the credit memo. | -| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The credit memo tax details. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the credit memo. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the credit memo. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `downloadable_links` - [`[DownloadableItemsLinks]`](#downloadableitemslinks) | A list of downloadable links that are ordered from the downloadable product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "adjustment": Money, - "base_grand_total": Money, + "custom_attributes": [CustomAttribute], "discounts": [Discount], - "grand_total": Money, - "shipping_handling": ShippingHandling, - "subtotal": Money, - "taxes": [TaxItem], - "total_shipping": Money, - "total_tax": Money + "downloadable_links": [DownloadableItemsLinks], + "eligible_for_return": false, + "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": "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": 123.45, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "abc123" } ``` -### Currency +### DownloadableProduct + +Defines a product that the shopper downloads. #### Fields | Field Name | Description | |------------|-------------| -| `available_currency_codes` - [`[String]`](#string) | An array of three-letter currency codes accepted by the store, such as USD and EUR. | -| `base_currency_code` - [`String`](#string) | The base currency set for the store, such as USD. | -| `base_currency_symbol` - [`String`](#string) | The symbol for the specified base currency, such as $. | -| `default_display_currency_code` - [`String`](#string) | The currency that is displayed by default, such as USD. | -| `default_display_currency_symbol` - [`String`](#string) | The currency symbol that is displayed by default, such as $. | -| `exchange_rates` - [`[ExchangeRate]`](#exchangerate) | An array of exchange rates for currencies defined in the store. | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `downloadable_product_links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for this downloadable product. | +| `downloadable_product_samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about samples of this downloadable product. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `links_purchased_separately` - [`Int`](#int) | A value of 1 indicates that each link in the array must be purchased separately. | +| `links_title` - [`String`](#string) | The heading above the list of downloadable products. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | #### Example ```json { - "available_currency_codes": ["abc123"], - "base_currency_code": "xyz789", - "base_currency_symbol": "abc123", - "default_display_currency_code": "abc123", - "default_display_currency_symbol": "xyz789", - "exchange_rates": [ExchangeRate] + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "country_of_manufacture": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "downloadable_product_links": [ + DownloadableProductLinks + ], + "downloadable_product_samples": [ + DownloadableProductSamples + ], + "gift_message_available": false, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "image": ProductImage, + "is_returnable": "xyz789", + "links_purchased_separately": 123, + "links_title": "xyz789", + "manufacturer": 987, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "related_products": [ProductInterface], + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_price": 987.65, + "special_to_date": "abc123", + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "uid": 4, + "upsell_products": [ProductInterface], + "url_key": "xyz789" } ``` -### CurrencyEnum - -The list of available currency codes. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `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` | | -| `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` | | - +### DownloadableProductCartItemInput + +Defines a single downloadable product. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customizable_options` - [`[CustomizableOptionInput]`](#customizableoptioninput) | The ID and value of the option. | +| `data` - [`CartItemInput!`](#cartiteminput) | The quantity and SKU of the downloadable product. | +| `downloadable_product_links` - [`[DownloadableProductLinksInput]`](#downloadableproductlinksinput) | An array of objects containing the link_id of the downloadable product link. | + #### Example ```json -""AFN"" +{ + "customizable_options": [CustomizableOptionInput], + "data": CartItemInput, + "downloadable_product_links": [ + DownloadableProductLinksInput + ] +} ``` -### CurrentProductInput +### DownloadableProductLinks -Attributes of the product currently being viewed on PDP +Defines characteristics of a downloadable product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `price` - [`Float`](#float) | The price of the downloadable product. | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the link. | +| `uid` - [`ID!`](#id) | The unique ID for a `DownloadableProductLinks` object. | + +#### Example + +```json +{ + "price": 123.45, + "sample_url": "xyz789", + "sort_order": 987, + "title": "abc123", + "uid": "4" +} +``` + + + +### DownloadableProductLinksInput + +Contains the link ID for the downloadable product. #### Input Fields | Input Field | Description | |-------------|-------------| -| `sku` - [`String`](#string) | SKU of the current product | -| `price` - [`Float`](#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | +| `link_id` - [`Int!`](#int) | The unique ID of the downloadable product link. | #### Example ```json -{"sku": "xyz789", "price": 987.65} +{"link_id": 123} ``` -### CustomAttribute +### DownloadableProductSamples -Specifies the custom attribute code and value. +Defines characteristics of a downloadable product. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_code` - [`String`](#string) | The custom attribute code. | -| `value` - [`String`](#string) | The custom attribute code value. | +| `sample_url` - [`String`](#string) | The full URL to the downloadable sample. | +| `sort_order` - [`Int`](#int) | A number indicating the sort order. | +| `title` - [`String`](#string) | The display name of the sample. | #### Example ```json { - "attribute_code": "abc123", - "value": "xyz789" + "sample_url": "xyz789", + "sort_order": 123, + "title": "xyz789" } ``` -### CustomAttributeInput +### DownloadableRequisitionListItem -Defines a custom attribute. +Contains details about downloadable products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array of links for downloadable products in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. | +| `quantity` - [`Float!`](#float) | The quantity of the product added to the requisition list. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array of links to downloadable product samples. | +| `sku` - [`String!`](#string) | The product SKU. | +| `uid` - [`ID!`](#id) | The unique ID of an item in a requisition list. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "links": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples], + "sku": "abc123", + "uid": 4 +} +``` + + + +### DownloadableWishlistItem + +A downloadable product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `links_v2` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the selected links. | +| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `samples` - [`[DownloadableProductSamples]`](#downloadableproductsamples) | An array containing information about the selected samples. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": 4, + "links_v2": [DownloadableProductLinks], + "product": ProductInterface, + "quantity": 123.45, + "samples": [DownloadableProductSamples] +} +``` + + + +### DuplicateNegotiableQuoteInput + +Identifies a quote to be duplicated #### Input Fields | Input Field | Description | |-------------|-------------| -| `attribute_code` - [`String!`](#string) | Attribute Code. | -| `value` - [`String!`](#string) | Attribute Value. | +| `duplicated_quote_uid` - [`ID!`](#id) | ID for the newly duplicated quote. | +| `quote_uid` - [`ID!`](#id) | ID of the quote to be duplicated. | #### Example ```json { - "attribute_code": "abc123", - "value": "abc123" + "duplicated_quote_uid": "4", + "quote_uid": 4 } ``` -### CustomAttributeMetadataInterface +### DuplicateNegotiableQuoteOutput -An interface containing fields that define the EAV attribute. +Contains the newly created negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | Negotiable Quote resulting from duplication operation. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### EnteredCustomAttributeInput + +Contains details about a custom text attribute that the buyer entered. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the entered custom attribute. | +| `value` - [`String!`](#string) | The text or other entered value. | + +#### Example + +```json +{ + "attribute_code": "xyz789", + "value": "xyz789" +} +``` + + + +### EnteredOptionInput + +Defines a customer-entered option. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `uid` - [`ID!`](#id) | The unique ID for a `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `value` - [`String!`](#string) | Text the customer entered. | + +#### Example + +```json +{"uid": 4, "value": "abc123"} +``` + + + +### Error + +An error encountered while adding an item to the the cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | #### Possible Types -| CustomAttributeMetadataInterface Types | +| Error Types | |----------------| -| [`AttributeMetadata`](#attributemetadata) | -| [`CatalogAttributeMetadata`](#catalogattributemetadata) | -| [`CustomerAttributeMetadata`](#customerattributemetadata) | -| [`ReturnItemAttributeMetadata`](#returnitemattributemetadata) | +| [`CartUserInputError`](#cartuserinputerror) | +| [`InsufficientStockError`](#insufficientstockerror) | #### Example ```json { - "code": 4, - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", - "frontend_input": "BOOLEAN", - "is_required": false, - "is_unique": true, - "label": "xyz789", - "options": [CustomAttributeOptionInterface] + "code": "PRODUCT_NOT_FOUND", + "message": "abc123" } ``` -### CustomAttributeOptionInterface +### ErrorInterface #### Fields | Field Name | Description | |------------|-------------| -| `is_default` - [`Boolean!`](#boolean) | Is the option value default. | -| `label` - [`String!`](#string) | The label assigned to the attribute option. | -| `value` - [`String!`](#string) | The attribute option value. | +| `message` - [`String!`](#string) | The returned error message. | #### Possible Types -| CustomAttributeOptionInterface Types | +| ErrorInterface Types | |----------------| -| [`AttributeOptionMetadata`](#attributeoptionmetadata) | +| [`InternalError`](#internalerror) | +| [`NegotiableQuoteInvalidStateError`](#negotiablequoteinvalidstateerror) | +| [`NoSuchEntityUidError`](#nosuchentityuiderror) | + +#### Example + +```json +{"message": "xyz789"} +``` + + + +### EstimateAddressInput + +Contains details about an address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `country_code` - [`CountryCodeEnum!`](#countrycodeenum) | The two-letter code representing the customer's country. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `region` - [`CustomerAddressRegionInput`](#customeraddressregioninput) | An object containing the region name, region code, and region ID. | #### Example ```json { - "is_default": false, - "label": "xyz789", - "value": "abc123" + "country_code": "AF", + "postcode": "xyz789", + "region": CustomerAddressRegionInput } ``` -### CustomConfigKeyValue +### EstimateTotalsInput -A simple key value object. +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`EstimateAddressInput!`](#estimateaddressinput) | Customer's address to estimate totals. | +| `cart_id` - [`String!`](#string) | The unique ID of the cart to query. | +| `shipping_method` - [`ShippingMethodInput`](#shippingmethodinput) | Selected shipping method to estimate totals. | + +#### Example + +```json +{ + "address": EstimateAddressInput, + "cart_id": "xyz789", + "shipping_method": ShippingMethodInput +} +``` + + + +### EstimateTotalsOutput + +Estimate totals output. #### Fields | Field Name | Description | |------------|-------------| -| `key` - [`String`](#string) | | -| `value` - [`String`](#string) | | +| `cart` - [`Cart`](#cart) | Cart after totals estimation | #### Example ```json -{ - "key": "abc123", - "value": "xyz789" -} +{"cart": Cart} ``` -### CustomOperatorInput +### ExchangeExternalCustomerTokenInput + +Contains details about external customer. #### Input Fields | Input Field | Description | |-------------|-------------| -| `type` - [`CustomOperatorType`](#customoperatortype) | | -| `value` - [`[String]`](#string) | | +| `customer` - [`CustomerCreateInput!`](#customercreateinput) | An input object that defines the customer characteristics to update. | + +#### Example + +```json +{"customer": CustomerCreateInput} +``` + + + +### ExchangeExternalCustomerTokenOutput + +Contains customer token for external customer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer` - [`Customer!`](#customer) | Return detailed information about a customer account. | +| `token` - [`String!`](#string) | The customer authorization token. | #### Example ```json { - "type": "UNKNOWN_CUSTOMOPERATOR_TYPE", - "value": ["xyz789"] + "customer": Customer, + "token": "xyz789" } ``` -### CustomOperatorType +### ExchangeRate -#### Values +Lists the exchange rate. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `UNKNOWN_CUSTOMOPERATOR_TYPE` | | -| `CUSTOM` | | +| `currency_to` - [`String`](#string) | Specifies the store’s default currency to exchange to. | +| `rate` - [`Float`](#float) | The exchange rate for the store’s default currency. | #### Example ```json -""UNKNOWN_CUSTOMOPERATOR_TYPE"" +{"currency_to": "xyz789", "rate": 123.45} ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md new file mode 100644 index 000000000..3a80881f0 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md @@ -0,0 +1,2720 @@ +## Types + +### FastlaneConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "code": "xyz789", + "is_visible": true, + "payment_intent": "xyz789", + "payment_source": "xyz789", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "three_ds_mode": "OFF", + "title": "abc123" +} +``` + + + +### FastlaneMethodInput + +Fastlane Payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `paypal_fastlane_token` - [`String`](#string) | The single use token from Fastlane | + +#### Example + +```json +{ + "payment_source": "xyz789", + "paypal_fastlane_token": "xyz789" +} +``` + + + +### Field + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNKNOWN_FIELD` | | +| `CATEGORY` | | +| `PRICE` | | +| `PRODUCT` | | +| `OUT_OF_STOCK` | | +| `LOW_STOCK` | | +| `TYPE` | | +| `VISIBILITY` | | + +#### Example + +```json +""UNKNOWN_FIELD"" +``` + + + +### FilterEqualTypeInput + +Defines a filter that matches the input exactly. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#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]`](#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 + +```json +{ + "eq": "abc123", + "in": ["abc123"] +} +``` + + + +### FilterMatchTypeEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `FULL` | | +| `PARTIAL` | | + +#### Example + +```json +""FULL"" +``` + + + +### FilterMatchTypeInput + +Defines a filter that performs a fuzzy search. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `match` - [`String`](#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`](#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 + +```json +{"match": "xyz789", "match_type": "FULL"} +``` + + + +### FilterRangeTypeInput + +Defines a filter that matches a range of values, such as prices or dates. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String`](#string) | Use this attribute to specify the lowest possible value in the range. | +| `to` - [`String`](#string) | Use this attribute to specify the highest possible value in the range. | + +#### Example + +```json +{ + "from": "abc123", + "to": "xyz789" +} +``` + + + +### FilterRuleInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`String`](#string) | | +| `type` - [`FilterRuleType`](#filterruletype) | | +| `conditions` - [`[ConditionInput]`](#conditioninput) | | + +#### Example + +```json +{ + "name": "abc123", + "type": "UNKNOWN_FILTER_RULE_TYPE", + "conditions": [ConditionInput] +} +``` + + + +### FilterRuleType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNKNOWN_FILTER_RULE_TYPE` | | +| `INCLUSION` | | +| `EXCLUSION` | | + +#### Example + +```json +""UNKNOWN_FILTER_RULE_TYPE"" +``` + + + +### FilterStringTypeInput + +Defines a filter for an input string. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Filters items that are exactly the same as the specified string. | +| `in` - [`[String]`](#string) | Filters items that are exactly the same as entries specified in an array of strings. | +| `match` - [`String`](#string) | Defines a filter that performs a fuzzy search using the specified string. | + +#### Example + +```json +{ + "eq": "xyz789", + "in": ["xyz789"], + "match": "abc123" +} +``` + + + +### FilterTypeInput + +Defines the comparison operators that can be used in a filter. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `eq` - [`String`](#string) | Equals. | +| `from` - [`String`](#string) | From. Must be used with the `to` field. | +| `gt` - [`String`](#string) | Greater than. | +| `gteq` - [`String`](#string) | Greater than or equal to. | +| `in` - [`[String]`](#string) | In. The value can contain a set of comma-separated values. | +| `like` - [`String`](#string) | Like. The specified value can contain % (percent signs) to allow matching of 0 or more characters. | +| `lt` - [`String`](#string) | Less than. | +| `lteq` - [`String`](#string) | Less than or equal to. | +| `moreq` - [`String`](#string) | More than or equal to. | +| `neq` - [`String`](#string) | Not equal to. | +| `nin` - [`[String]`](#string) | Not in. The value can contain a set of comma-separated values. | +| `notnull` - [`String`](#string) | Not null. | +| `null` - [`String`](#string) | Is null. | +| `to` - [`String`](#string) | To. Must be used with the `from` field. | + +#### Example + +```json +{ + "eq": "xyz789", + "from": "abc123", + "gt": "abc123", + "gteq": "xyz789", + "in": ["abc123"], + "like": "abc123", + "lt": "xyz789", + "lteq": "abc123", + "moreq": "xyz789", + "neq": "abc123", + "nin": ["abc123"], + "notnull": "abc123", + "null": "xyz789", + "to": "xyz789" +} +``` + + + +### FilterableInSearchAttribute + +Contains product attributes that can be used for filtering in a `productSearch` query + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute` - [`String!`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without spaces | +| `frontendInput` - [`String`](#string) | Indicates how field rendered on storefront | +| `label` - [`String`](#string) | The display name assigned to the attribute | +| `numeric` - [`Boolean`](#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | + +#### Example + +```json +{ + "attribute": "abc123", + "frontendInput": "xyz789", + "label": "xyz789", + "numeric": true +} +``` + + + +### FixedProductTax + +A single FPT that can be applied to a product price. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount of the Fixed Product Tax. | +| `label` - [`String`](#string) | The display label assigned to the Fixed Product Tax. | + +#### Example + +```json +{ + "amount": Money, + "label": "xyz789" +} +``` + + + +### FixedProductTaxDisplaySettings + +Lists display settings for the Fixed Product Tax. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""INCLUDE_FPT_WITHOUT_DETAILS"" +``` + + + +### Float + +The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). + +#### Example + +```json +987.65 +``` + + + +### GenerateCustomerTokenAsAdminInput + +Identifies which customer requires remote shopping assistance. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customer_email` - [`String!`](#string) | The email address of the customer requesting remote shopping assistance. | + +#### Example + +```json +{"customer_email": "abc123"} +``` + + + +### GenerateCustomerTokenAsAdminOutput + +Contains the generated customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customer_token` - [`String!`](#string) | The generated customer token. | + +#### Example + +```json +{"customer_token": "xyz789"} +``` + + + +### GenerateNegotiableQuoteFromTemplateInput + +Specifies the template id, from which to generate quote from. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"template_id": "4"} +``` + + + +### GenerateNegotiableQuoteFromTemplateOutput + +Contains the generated negotiable quote id. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `negotiable_quote_uid` - [`ID!`](#id) | The unique ID of a generated `NegotiableQuote` object. | + +#### Example + +```json +{"negotiable_quote_uid": "4"} +``` + + + +### GetPaymentSDKOutput + +Gets the payment SDK URLs and values + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sdkParams` - [`[PaymentSDKParamsItem]`](#paymentsdkparamsitem) | The payment SDK parameters | + +#### Example + +```json +{"sdkParams": [PaymentSDKParamsItem]} +``` + + + +### GiftCardAccount + +Contains details about the gift card account. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`Money`](#money) | The balance remaining on the gift card. | +| `code` - [`String`](#string) | The gift card account code. | +| `expiration_date` - [`String`](#string) | The expiration date of the gift card. | + +#### Example + +```json +{ + "balance": Money, + "code": "xyz789", + "expiration_date": "abc123" +} +``` + + + +### GiftCardAccountInput + +Contains the gift card code. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `gift_card_code` - [`String!`](#string) | The applied gift card code. | + +#### Example + +```json +{"gift_card_code": "abc123"} +``` + + + +### GiftCardAmounts + +Contains the value of a gift card, the website that generated the card, and related information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_id` - [`Int`](#int) | An internal attribute ID. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftCardAmounts` object. | +| `value` - [`Float`](#float) | The value of the gift card. | +| `website_id` - [`Int`](#int) | The ID of the website that generated the gift card. | +| `website_value` - [`Float`](#float) | The value of the gift card. | + +#### Example + +```json +{ + "attribute_id": 987, + "uid": "4", + "value": 123.45, + "website_id": 123, + "website_value": 987.65 +} +``` + + + +### GiftCardCartItem + +Contains details about a gift card that has been added to a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount and currency of the gift card. | +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String!`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender. | +| `sender_name` - [`String!`](#string) | The name of the sender. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "amount": Money, + "available_gift_wrapping": [GiftWrapping], + "backorder_message": "abc123", + "custom_attributes": [CustomAttribute], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "is_available": false, + "is_salable": 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": "abc123", + "recipient_name": "abc123", + "sender_email": "abc123", + "sender_name": "abc123", + "uid": "4" +} +``` + + + +### GiftCardCreditMemoItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the credit memo item | +| `discounts` - [`[Discount]`](#discount) | Details about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a credit memo item. | +| `id` - [`ID!`](#id) | The unique ID for a `CreditMemoItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item the credit memo is applied to. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_refunded": 987.65 +} +``` + + + +### GiftCardInvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an invoice item. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "gift_card": GiftCardItem, + "id": "4", + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_invoiced": 987.65 +} +``` + + + +### GiftCardItem + +Contains details about a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String`](#string) | The message from the sender to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the receiver of a virtual gift card. | +| `recipient_name` - [`String`](#string) | The name of the receiver of a physical or virtual gift card. | +| `sender_email` - [`String`](#string) | The email address of the sender of a virtual gift card. | +| `sender_name` - [`String`](#string) | The name of the sender of a physical or virtual gift card. | + +#### Example + +```json +{ + "message": "abc123", + "recipient_email": "xyz789", + "recipient_name": "xyz789", + "sender_email": "abc123", + "sender_name": "xyz789" +} +``` + + + +### GiftCardOptions + +Contains details about the sender, recipient, and amount of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money`](#money) | The amount and currency of the gift card. | +| `custom_giftcard_amount` - [`Money`](#money) | The custom amount and currency of the gift card. | +| `message` - [`String`](#string) | A message to the recipient. | +| `recipient_email` - [`String`](#string) | The email address of the person receiving the gift card. | +| `recipient_name` - [`String`](#string) | The name of the person receiving the gift card. | +| `sender_email` - [`String`](#string) | The email address of the person sending the gift card. | +| `sender_name` - [`String`](#string) | The name of the person sending the gift card. | + +#### Example + +```json +{ + "amount": Money, + "custom_giftcard_amount": Money, + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "abc123" +} +``` + + + +### GiftCardOrderItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for an order item. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttribute], + "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": "abc123", + "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, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" +} +``` + + + +### GiftCardProduct + +Defines properties of a gift card. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `allow_message` - [`Boolean`](#boolean) | Indicates whether the customer can provide a message to accompany the gift card. | +| `allow_open_amount` - [`Boolean`](#boolean) | Indicates whether shoppers have the ability to set the value of the gift card. | +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_card_options` - [`[CustomizableOptionInterface]!`](#customizableoptioninterface) | An array of customizable gift card options. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `giftcard_amounts` - [`[GiftCardAmounts]`](#giftcardamounts) | An array that contains information about the values and ID of a gift card. | +| `giftcard_type` - [`GiftCardTypeEnum`](#giftcardtypeenum) | An enumeration that specifies the type of gift card. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_redeemable` - [`Boolean`](#boolean) | Indicates whether the customer can redeem the value on the card for cash. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `lifetime` - [`Int`](#int) | The number of days after purchase until the gift card expires. A null value means there is no limit. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `message_max_length` - [`Int`](#int) | The maximum number of characters the gift message can contain. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `open_amount_max` - [`Float`](#float) | The maximum acceptable value of an open amount gift card. | +| `open_amount_min` - [`Float`](#float) | The minimum acceptable value of an open amount gift card. | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "allow_message": true, + "allow_open_amount": false, + "canonical_url": "abc123", + "categories": [CategoryInterface], + "country_of_manufacture": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_card_options": [CustomizableOptionInterface], + "gift_message_available": false, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "giftcard_amounts": [GiftCardAmounts], + "giftcard_type": "VIRTUAL", + "image": ProductImage, + "is_redeemable": true, + "is_returnable": "xyz789", + "lifetime": 123, + "manufacturer": 123, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "message_max_length": 987, + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "open_amount_max": 987.65, + "open_amount_min": 123.45, + "options": [CustomizableOptionInterface], + "options_container": "xyz789", + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "related_products": [ProductInterface], + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_price": 987.65, + "special_to_date": "abc123", + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "thumbnail": ProductImage, + "uid": "4", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "weight": 123.45 +} +``` + + + +### GiftCardRequisitionListItem + +Contains details about gift cards added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | An array that defines gift card properties. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The amount added. | +| `sku` - [`String!`](#string) | The product SKU. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "gift_card_options": GiftCardOptions, + "product": ProductInterface, + "quantity": 123.45, + "sku": "xyz789", + "uid": "4" +} +``` + + + +### GiftCardShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_card` - [`GiftCardItem`](#giftcarditem) | Selected gift card properties for a shipment item. | +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "gift_card": GiftCardItem, + "id": 4, + "order_item": OrderItemInterface, + "product_name": "xyz789", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_shipped": 123.45 +} +``` + + + +### GiftCardTypeEnum + +Specifies the gift card type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `VIRTUAL` | | +| `PHYSICAL` | | +| `COMBINED` | | + +#### Example + +```json +""VIRTUAL"" +``` + + + +### GiftCardWishlistItem + +A single gift card added to a wish list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `gift_card_options` - [`GiftCardOptions!`](#giftcardoptions) | Details about a gift card. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "gift_card_options": GiftCardOptions, + "id": "4", + "product": ProductInterface, + "quantity": 123.45 +} +``` + + + +### GiftMessage + +Contains the text of a gift message, its sender, and recipient + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `from` - [`String!`](#string) | Sender name | +| `message` - [`String!`](#string) | Gift message text | +| `to` - [`String!`](#string) | Recipient name | + +#### Example + +```json +{ + "from": "xyz789", + "message": "xyz789", + "to": "abc123" +} +``` + + + +### GiftMessageInput + +Defines a gift message. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`String!`](#string) | The name of the sender. | +| `message` - [`String!`](#string) | The text of the gift message. | +| `to` - [`String!`](#string) | The name of the recepient. | + +#### Example + +```json +{ + "from": "xyz789", + "message": "abc123", + "to": "xyz789" +} +``` + + + +### GiftOptionsPrices + +Contains prices for gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_wrapping_for_items` - [`Money`](#money) | Price of the gift wrapping for all individual order items. | +| `gift_wrapping_for_items_incl_tax` - [`Money`](#money) | Price of the gift wrapping for all individual order items including tax. | +| `gift_wrapping_for_order` - [`Money`](#money) | Price of the gift wrapping for the whole order. | +| `gift_wrapping_for_order_incl_tax` - [`Money`](#money) | Price of the gift wrapping for the whole order including tax. | +| `printed_card` - [`Money`](#money) | Price for the printed card. | +| `printed_card_incl_tax` - [`Money`](#money) | Price for the printed card including tax. | + +#### Example + +```json +{ + "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 +} +``` + + + +### GiftRegistry + +Contains details about a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date on which the gift registry was created. Only the registry owner can access this attribute. | +| `dynamic_attributes` - [`[GiftRegistryDynamicAttribute]`](#giftregistrydynamicattribute) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `event_name` - [`String!`](#string) | The name of the event. | +| `items` - [`[GiftRegistryItemInterface]`](#giftregistryiteminterface) | An array of products added to the gift registry. | +| `message` - [`String!`](#string) | The message text the customer entered to describe the event. | +| `owner_name` - [`String!`](#string) | The customer who created the gift registry. | +| `privacy_settings` - [`GiftRegistryPrivacySettings!`](#giftregistryprivacysettings) | An enum that states whether the gift registry is PRIVATE or PUBLIC. Only the registry owner can access this attribute. | +| `registrants` - [`[GiftRegistryRegistrant]`](#giftregistryregistrant) | Contains details about each registrant for the event. | +| `shipping_address` - [`CustomerAddress`](#customeraddress) | Contains the customer's shipping address. Only the registry owner can access this attribute. | +| `status` - [`GiftRegistryStatus!`](#giftregistrystatus) | An enum that states whether the gift registry is ACTIVE or INACTIVE. Only the registry owner can access this attribute. | +| `type` - [`GiftRegistryType`](#giftregistrytype) | The type of gift registry. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry. | + +#### Example + +```json +{ + "created_at": "abc123", + "dynamic_attributes": [GiftRegistryDynamicAttribute], + "event_name": "xyz789", + "items": [GiftRegistryItemInterface], + "message": "xyz789", + "owner_name": "abc123", + "privacy_settings": "PRIVATE", + "registrants": [GiftRegistryRegistrant], + "shipping_address": CustomerAddress, + "status": "ACTIVE", + "type": GiftRegistryType, + "uid": 4 +} +``` + + + +### GiftRegistryDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `group` - [`GiftRegistryDynamicAttributeGroup!`](#giftregistrydynamicattributegroup) | Indicates which group the dynamic attribute is a member of. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": 4, + "group": "EVENT_INFORMATION", + "label": "abc123", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeGroup + +Defines the group type of a gift registry dynamic attribute. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `EVENT_INFORMATION` | | +| `PRIVACY_SETTINGS` | | +| `REGISTRANT` | | +| `GENERAL_INFORMATION` | | +| `DETAILED_INFORMATION` | | +| `SHIPPING_ADDRESS` | | + +#### Example + +```json +""EVENT_INFORMATION"" +``` + + + +### GiftRegistryDynamicAttributeInput + +Defines a dynamic attribute. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `code` - [`ID!`](#id) | A unique key for an additional attribute of the event. | +| `value` - [`String!`](#string) | A string that describes a dynamic attribute. | + +#### Example + +```json +{ + "code": "4", + "value": "abc123" +} +``` + + + +### GiftRegistryDynamicAttributeInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Possible Types + +| GiftRegistryDynamicAttributeInterface Types | +|----------------| +| [`GiftRegistryDynamicAttribute`](#giftregistrydynamicattribute) | +| [`GiftRegistryRegistrantDynamicAttribute`](#giftregistryregistrantdynamicattribute) | + +#### Example + +```json +{ + "code": 4, + "label": "abc123", + "value": "xyz789" +} +``` + + + +### GiftRegistryDynamicAttributeMetadata + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Example + +```json +{ + "attribute_group": "xyz789", + "code": 4, + "input_type": "xyz789", + "is_required": true, + "label": "xyz789", + "sort_order": 123 +} +``` + + + +### GiftRegistryDynamicAttributeMetadataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute_group` - [`String!`](#string) | Indicates which group the dynamic attribute a member of. | +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `input_type` - [`String!`](#string) | The selected input type for this dynamic attribute. The value can be one of several static or custom types. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the dynamic attribute is required. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `sort_order` - [`Int`](#int) | The order in which to display the dynamic attribute. | + +#### Possible Types + +| GiftRegistryDynamicAttributeMetadataInterface Types | +|----------------| +| [`GiftRegistryDynamicAttributeMetadata`](#giftregistrydynamicattributemetadata) | + +#### Example + +```json +{ + "attribute_group": "abc123", + "code": "4", + "input_type": "abc123", + "is_required": true, + "label": "xyz789", + "sort_order": 987 +} +``` + + + +### GiftRegistryItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface!`](#productinterface) | Details about the gift registry item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "xyz789", + "product": ProductInterface, + "quantity": 123.45, + "quantity_fulfilled": 987.65, + "uid": "4" +} +``` + + + +### GiftRegistryItemInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | The date the product was added to the gift registry. | +| `note` - [`String`](#string) | A brief message about the gift registry item. | +| `product` - [`ProductInterface!`](#productinterface) | Details about the gift registry item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The requested quantity of the product. | +| `quantity_fulfilled` - [`Float!`](#float) | The fulfilled quantity of the product. | +| `uid` - [`ID!`](#id) | The unique ID of a gift registry item. | + +#### Possible Types + +| GiftRegistryItemInterface Types | +|----------------| +| [`GiftRegistryItem`](#giftregistryitem) | + +#### Example + +```json +{ + "created_at": "abc123", + "note": "abc123", + "product": ProductInterface, + "quantity": 123.45, + "quantity_fulfilled": 123.45, + "uid": 4 +} +``` + + + +### GiftRegistryItemUserErrorInterface + +Contains the status and any errors that encountered with the customer's gift register item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | + +#### Possible Types + +| GiftRegistryItemUserErrorInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{ + "status": false, + "user_errors": [GiftRegistryItemsUserError] +} +``` + + + +### GiftRegistryItemsUserError + +Contains details about an error that occurred when processing a gift registry item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`GiftRegistryItemsUserErrorType!`](#giftregistryitemsusererrortype) | An error code that describes the error encountered. | +| `gift_registry_item_uid` - [`ID`](#id) | The unique ID of the gift registry item containing an error. | +| `gift_registry_uid` - [`ID`](#id) | The unique ID of the `GiftRegistry` object containing an error. | +| `message` - [`String!`](#string) | A localized error message. | +| `product_uid` - [`ID`](#id) | The unique ID of the product containing an error. | + +#### Example + +```json +{ + "code": "OUT_OF_STOCK", + "gift_registry_item_uid": "4", + "gift_registry_uid": 4, + "message": "abc123", + "product_uid": 4 +} +``` + + + +### GiftRegistryItemsUserErrorType + +Defines the error type. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""OUT_OF_STOCK"" +``` + + + +### GiftRegistryOutputInterface + +Contains the customer's gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | + +#### Possible Types + +| GiftRegistryOutputInterface Types | +|----------------| +| [`MoveCartItemsToGiftRegistryOutput`](#movecartitemstogiftregistryoutput) | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### GiftRegistryPrivacySettings + +Defines the privacy setting of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PRIVATE` | | +| `PUBLIC` | | + +#### Example + +```json +""PRIVATE"" +``` + + + +### GiftRegistryRegistrant + +Contains details about a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes` - [`[GiftRegistryRegistrantDynamicAttribute]`](#giftregistryregistrantdynamicattribute) | An array of dynamic attributes assigned to the registrant. | +| `email` - [`String!`](#string) | The email address of the registrant. Only the registry owner can access this attribute. | +| `firstname` - [`String!`](#string) | The first name of the registrant. | +| `lastname` - [`String!`](#string) | The last name of the registrant. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the registrant. | + +#### Example + +```json +{ + "dynamic_attributes": [ + GiftRegistryRegistrantDynamicAttribute + ], + "email": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", + "uid": 4 +} +``` + + + +### GiftRegistryRegistrantDynamicAttribute + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The internal ID of the dynamic attribute. | +| `label` - [`String!`](#string) | The display name of the dynamic attribute. | +| `value` - [`String!`](#string) | A corresponding value for the code. | + +#### Example + +```json +{ + "code": "4", + "label": "abc123", + "value": "xyz789" +} +``` + + + +### GiftRegistrySearchResult + +Contains the results of a gift registry search. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `event_date` - [`String`](#string) | The date of the event. | +| `event_title` - [`String!`](#string) | The title given to the event. | +| `gift_registry_uid` - [`ID!`](#id) | The URL key of the gift registry. | +| `location` - [`String`](#string) | The location of the event. | +| `name` - [`String!`](#string) | The name of the gift registry owner. | +| `type` - [`String`](#string) | The type of event being held. | + +#### Example + +```json +{ + "event_date": "xyz789", + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "xyz789", + "name": "xyz789", + "type": "abc123" +} +``` + + + +### GiftRegistryShippingAddressInput + +Defines a shipping address for a gift registry. Specify either `address_data` or the `address_id`. If both are provided, validation will fail. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address_data` - [`CustomerAddressInput`](#customeraddressinput) | Defines the shipping address for this gift registry. | +| `address_id` - [`ID`](#id) | The ID assigned to this customer address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID assigned to this customer address. | + +#### Example + +```json +{ + "address_data": CustomerAddressInput, + "address_id": "4", + "customer_address_uid": 4 +} +``` + + + +### GiftRegistryStatus + +Defines the status of the gift registry. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ACTIVE` | | +| `INACTIVE` | | + +#### Example + +```json +""ACTIVE"" +``` + + + +### GiftRegistryType + +Contains details about a gift registry type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `dynamic_attributes_metadata` - [`[GiftRegistryDynamicAttributeMetadataInterface]`](#giftregistrydynamicattributemetadatainterface) | An array of attributes that define elements of the gift registry. Each attribute is specified as a code-value pair. | +| `label` - [`String!`](#string) | The label assigned to the gift registry type on the Admin. | +| `uid` - [`ID!`](#id) | The unique ID assigned to the gift registry type. | + +#### Example + +```json +{ + "dynamic_attributes_metadata": [ + GiftRegistryDynamicAttributeMetadataInterface + ], + "label": "abc123", + "uid": 4 +} +``` + + + +### GiftWrapping + +Contains details about the selected or available gift wrapping options. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `design` - [`String!`](#string) | The name of the gift wrapping design. | +| `image` - [`GiftWrappingImage`](#giftwrappingimage) | The preview image for a gift wrapping option. | +| `price` - [`Money!`](#money) | The gift wrapping price. | +| `uid` - [`ID!`](#id) | The unique ID for a `GiftWrapping` object. | + +#### Example + +```json +{ + "design": "abc123", + "image": GiftWrappingImage, + "price": Money, + "uid": 4 +} +``` + + + +### GiftWrappingImage + +Points to an image associated with a gift wrapping option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The gift wrapping preview image label. | +| `url` - [`String!`](#string) | The gift wrapping preview image URL. | + +#### Example + +```json +{ + "label": "xyz789", + "url": "abc123" +} +``` + + + +### GooglePayButtonStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `color` - [`String`](#string) | The button color | +| `height` - [`Int`](#int) | The button height in pixels | +| `type` - [`String`](#string) | The button type | + +#### Example + +```json +{ + "color": "abc123", + "height": 987, + "type": "abc123" +} +``` + + + +### GooglePayConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `button_styles` - [`GooglePayButtonStyles`](#googlepaybuttonstyles) | The styles for the GooglePay Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "button_styles": GooglePayButtonStyles, + "code": "abc123", + "is_visible": false, + "payment_intent": "abc123", + "payment_source": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "three_ds_mode": "OFF", + "title": "abc123" +} +``` + + + +### GooglePayMethodInput + +Google Pay inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "xyz789", + "paypal_order_id": "abc123" +} +``` + + + +### GroupedProduct + +Defines a grouped product, which consists of simple standalone products that are presented as a group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `items` - [`[GroupedProductItem]`](#groupedproductitem) | An array containing grouped product items. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "canonical_url": "abc123", + "categories": [CategoryInterface], + "country_of_manufacture": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": true, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "image": ProductImage, + "is_returnable": "abc123", + "items": [GroupedProductItem], + "manufacturer": 987, + "max_sale_qty": 987.65, + "media_gallery": [MediaGalleryInterface], + "meta_description": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", + "new_from_date": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options_container": "xyz789", + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 987.65, + "related_products": [ProductInterface], + "short_description": ComplexTextValue, + "sku": "abc123", + "small_image": ProductImage, + "special_price": 123.45, + "special_to_date": "xyz789", + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "thumbnail": ProductImage, + "uid": "4", + "upsell_products": [ProductInterface], + "url_key": "abc123", + "weight": 123.45 +} +``` + + + +### GroupedProductItem + +Contains information about an individual grouped product item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `position` - [`Int`](#int) | The relative position of this item compared to the other group items. | +| `product` - [`ProductInterface!`](#productinterface) | Details about this product option. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `qty` - [`Float`](#float) | The quantity of this grouped product item. | + +#### Example + +```json +{ + "position": 123, + "product": ProductInterface, + "qty": 123.45 +} +``` + + + +### GroupedProductWishlistItem + +A grouped product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "xyz789", + "customizable_options": [SelectedCustomizableOption], + "description": "xyz789", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### GuestOrderCancelInput + +Input to retrieve a guest order based on token. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `reason` - [`String!`](#string) | Cancellation reason. | +| `token` - [`String!`](#string) | Order token. | + +#### Example + +```json +{ + "reason": "abc123", + "token": "abc123" +} +``` + + + +### GuestOrderInformationInput + +Input to retrieve an order based on details. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | Order billing address email. | +| `lastname` - [`String!`](#string) | Order billing address lastname. | +| `number` - [`String!`](#string) | Order number. | + +#### Example + +```json +{ + "email": "abc123", + "lastname": "abc123", + "number": "abc123" +} +``` + + + +### Highlight + +An object that provides highlighted text for matched words + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute` - [`String!`](#string) | The product attribute that contains a match for the search phrase | +| `matched_words` - [`[String]!`](#string) | An array of strings | +| `value` - [`String!`](#string) | The matched text, enclosed within emphasis tags | + +#### Example + +```json +{ + "attribute": "abc123", + "matched_words": ["xyz789"], + "value": "abc123" +} +``` + + + +### HistoryItemNoteData + +Item note data that is added to the negotiable quote history object. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String!`](#string) | Datetime of the note added. | +| `creator_name` - [`String!`](#string) | Name of the creator. | +| `creator_type` - [`String!`](#string) | Creator type: Buyer or Seller. | +| `item_id` - [`Int!`](#int) | Id of the quote item for which the note has been added. | +| `note` - [`String!`](#string) | The note added by the creator for the item | +| `product_name` - [`String!`](#string) | Name of the quote item product for which note has been added. | + +#### Example + +```json +{ + "created_at": "xyz789", + "creator_name": "xyz789", + "creator_type": "xyz789", + "item_id": 123, + "note": "abc123", + "product_name": "xyz789" +} +``` + + + +### HostedFieldsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cc_vault_code` - [`String`](#string) | Vault payment method code | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_vault_enabled` - [`Boolean`](#boolean) | Card vault enabled | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `requires_card_details` - [`Boolean`](#boolean) | Card and bin details required | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `three_ds_mode` - [`ThreeDSMode`](#threedsmode) | 3DS mode | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "cc_vault_code": "abc123", + "code": "xyz789", + "is_vault_enabled": false, + "is_visible": true, + "payment_intent": "abc123", + "payment_source": "xyz789", + "requires_card_details": true, + "sdk_params": [SDKParams], + "sort_order": "abc123", + "three_ds_mode": "OFF", + "title": "abc123" +} +``` + + + +### HostedFieldsInput + +Hosted Fields payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cardBin` - [`String`](#string) | Card bin number | +| `cardExpiryMonth` - [`String`](#string) | Expiration month of the card | +| `cardExpiryYear` - [`String`](#string) | Expiration year of the card | +| `cardLast4` - [`String`](#string) | Last four digits of the card | +| `holderName` - [`String`](#string) | Name on the card | +| `is_active_payment_token_enabler` - [`Boolean`](#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`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cardBin": "xyz789", + "cardExpiryMonth": "abc123", + "cardExpiryYear": "abc123", + "cardLast4": "xyz789", + "holderName": "abc123", + "is_active_payment_token_enabler": true, + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" +} +``` + + + +### ID + +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 + +```json +"4" +``` + + + +### ImageSwatchData + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `thumbnail` - [`String`](#string) | The URL assigned to the thumbnail of the swatch image. | +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Example + +```json +{ + "thumbnail": "xyz789", + "value": "abc123" +} +``` + + + +### ImportSharedRequisitionListOutput + +Result of importing a shared requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The imported requisition list for the current customer. | +| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Validation or import issues. | + +#### Example + +```json +{ + "requisition_list": RequisitionList, + "user_errors": [ShareRequisitionListUserError] +} +``` + + + +### InputFilterEnum + +List of templates/filters applied to customer attribute input. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""NONE"" +``` + + + +### InsufficientStockError + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`CartUserInputErrorType!`](#cartuserinputerrortype) | A cart-specific error code. | +| `message` - [`String!`](#string) | A localized error message. | +| `quantity` - [`Float`](#float) | Amount of available stock | + +#### Example + +```json +{ + "code": "PRODUCT_NOT_FOUND", + "message": "abc123", + "quantity": 123.45 +} +``` + + + +### Int + +The `Int` scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1. + +#### Example + +```json +987 +``` + + + +### InternalError + +Contains an error message when an internal error occurred. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The returned error message. | + +#### Example + +```json +{"message": "abc123"} +``` + + + +### Invoice + +Contains invoice details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments on the invoice. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice | +| `id` - [`ID!`](#id) | The unique ID for a `Invoice` object. | +| `items` - [`[InvoiceItemInterface]`](#invoiceiteminterface) | Invoiced product details. | +| `number` - [`String!`](#string) | Sequential invoice number. | +| `total` - [`InvoiceTotal`](#invoicetotal) | Invoice total amount details. | + +#### Example + +```json +{ + "comments": [SalesCommentItem], + "custom_attributes": [CustomAttribute], + "id": 4, + "items": [InvoiceItemInterface], + "number": "xyz789", + "total": InvoiceTotal +} +``` + + + +### InvoiceCustomAttributesInput + +Defines an invoice custom attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for invoice. | +| `invoice_id` - [`String!`](#string) | The invoice ID. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttributeInput], + "invoice_id": "abc123" +} +``` + + + +### InvoiceItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 123.45 +} +``` + + + +### InvoiceItemCustomAttributesInput + +Defines an invoice item custom attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for invoice item. | +| `invoice_id` - [`String!`](#string) | The invoice ID. | +| `invoice_item_id` - [`String!`](#string) | The invoice item ID. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttributeInput], + "invoice_id": "xyz789", + "invoice_item_id": "xyz789" +} +``` + + + +### InvoiceItemInterface + +Contains detailes about invoiced items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the invoice item | +| `discounts` - [`[Discount]`](#discount) | Information about the final discount amount for the base product, including discounts on options. | +| `id` - [`ID!`](#id) | The unique ID for an `InvoiceItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | Details about an individual order item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | + +#### Possible Types + +| InvoiceItemInterface Types | +|----------------| +| [`BundleInvoiceItem`](#bundleinvoiceitem) | +| [`DownloadableInvoiceItem`](#downloadableinvoiceitem) | +| [`GiftCardInvoiceItem`](#giftcardinvoiceitem) | +| [`InvoiceItem`](#invoiceitem) | + +#### Example + +```json +{ + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "id": "4", + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "xyz789", + "quantity_invoiced": 123.45 +} +``` + + + +### InvoiceOutput + +Contains details about the invoice after adding custom attributes to it. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `invoice` - [`Invoice!`](#invoice) | The custom attributes to invoice have been added. | + +#### Example + +```json +{"invoice": Invoice} +``` + + + +### InvoiceTotal + +Contains price details from an invoice. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the invoice. | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the invoice. | +| `subtotal` - [`Money!`](#money) | The subtotal of the invoice, excluding shipping, discounts, and taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The invoice tax details. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the invoice. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the invoice. | + +#### Example + +```json +{ + "base_grand_total": Money, + "discounts": [Discount], + "grand_total": Money, + "shipping_handling": ShippingHandling, + "subtotal": Money, + "taxes": [TaxItem], + "total_shipping": Money, + "total_tax": Money +} +``` + + + +### IsCompanyAdminEmailAvailableOutput + +Contains the response of a company admin email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company administrator. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsCompanyEmailAvailableOutput + +Contains the response of a company email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsCompanyRoleNameAvailableOutput + +Contains the response of a role name validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_role_name_available` - [`Boolean!`](#boolean) | Indicates whether the specified company role name is available. | + +#### Example + +```json +{"is_role_name_available": true} +``` + + + +### IsCompanyUserEmailAvailableOutput + +Contains the response of a company user email validation query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean!`](#boolean) | Indicates whether the specified email address can be used to create a company user. | + +#### Example + +```json +{"is_email_available": false} +``` + + + +### IsEmailAvailableOutput + +Contains the result of the `isEmailAvailable` query. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_email_available` - [`Boolean`](#boolean) | Indicates whether the specified email address can be used to create a customer. | + +#### Example + +```json +{"is_email_available": true} +``` + + + +### IsOperatorInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `type` - [`IsOperatorType`](#isoperatortype) | | +| `value` - [`Boolean`](#boolean) | | + +#### Example + +```json +{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true} +``` + + + +### IsOperatorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNKNOWN_ISOPERATOR_TYPE` | | +| `IS` | | + +#### Example + +```json +""UNKNOWN_ISOPERATOR_TYPE"" +``` + + + +### IsProductAlertSubscriptionResult + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `isSubscribed` - [`Boolean!`](#boolean) | | +| `message` - [`String`](#string) | | + +#### Example + +```json +{"isSubscribed": true, "message": "abc123"} +``` + + + +### ItemNote + +The note object for quote line item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `created_at` - [`String`](#string) | Timestamp that reflects note creation date. | +| `creator_id` - [`Int`](#int) | ID of the user who submitted a note. | +| `creator_name` - [`String`](#string) | Name of the creator. | +| `creator_type` - [`Int`](#int) | Type of teh user who submitted a note. | +| `negotiable_quote_item_uid` - [`ID`](#id) | The unique ID of a `CartItemInterface` object. | +| `note` - [`String`](#string) | Note text. | +| `note_uid` - [`ID`](#id) | The unique ID of a `ItemNote` object. | + +#### Example + +```json +{ + "created_at": "abc123", + "creator_id": 987, + "creator_name": "abc123", + "creator_type": 987, + "negotiable_quote_item_uid": "4", + "note": "xyz789", + "note_uid": "4" +} +``` + + + +### ItemSelectedBundleOption + +A list of options of the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The label of the option. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOption` object. | +| `values` - [`[ItemSelectedBundleOptionValue]`](#itemselectedbundleoptionvalue) | A list of products that represent the values of the parent option. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": "4", + "values": [ItemSelectedBundleOptionValue] +} +``` + + + +### ItemSelectedBundleOptionValue + +A list of values for the selected bundle product. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `price` - [`Money!`](#money) | The price of the child bundle product. | +| `product_name` - [`String!`](#string) | The name of the child bundle product. | +| `product_sku` - [`String!`](#string) | The SKU of the child bundle product. | +| `quantity` - [`Float!`](#float) | The number of this bundle product that were ordered. | +| `uid` - [`ID!`](#id) | The unique ID for a `ItemSelectedBundleOptionValue` object. | + +#### Example + +```json +{ + "price": Money, + "product_name": "abc123", + "product_sku": "xyz789", + "quantity": 123.45, + "uid": 4 +} +``` + + + +### JSON + +A JSON scalar + +#### Example + +```json +{} +``` + + + +### finishUploadInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `key` - [`String!`](#string) | The unique key identifier from the upload | +| `media_resource_type` - [`MediaResourceType!`](#mediaresourcetype) | The type of media resource being uploaded | + +#### Example + +```json +{ + "key": "abc123", + "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" +} +``` + + + +### finishUploadOutput + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `key` - [`String!`](#string) | The unique key identifier | +| `message` - [`String`](#string) | Additional information about the confirmation | +| `success` - [`Boolean!`](#boolean) | Whether the confirmation was successful | + +#### Example + +```json +{ + "key": "abc123", + "message": "abc123", + "success": true +} +``` + + + +### initiateUploadInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `key` - [`String!`](#string) | The name of the file to be uploaded, cannot contain slashes | +| `media_resource_type` - [`MediaResourceType!`](#mediaresourcetype) | The type of media resource being uploaded | + +#### Example + +```json +{ + "key": "abc123", + "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" +} +``` + + + +### initiateUploadOutput + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `expires_at` - [`String!`](#string) | The expiration timestamp of the URL | +| `key` - [`String!`](#string) | The unique key identifier for the upload | +| `upload_url` - [`String!`](#string) | The presigned URL for uploading the file | + +#### Example + +```json +{ + "expires_at": "abc123", + "key": "xyz789", + "upload_url": "xyz789" +} +``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-3.md b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md similarity index 54% rename from src/pages/includes/autogenerated/graphql-api-saas-types-3.md rename to src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md index e0544326e..12c4d5c7e 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-3.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md @@ -1,7365 +1,4980 @@ -### NegotiableQuoteTemplateHistoryEntry +## Types -Contains details about a change for a negotiable quote template. +### KeyValue + +Contains a key-value pair. #### Fields | Field Name | Description | |------------|-------------| -| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | -| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that specifies the reason for a status change in the negotiable quote history entry. | -| `changes` - [`NegotiableQuoteTemplateHistoryChanges`](#negotiablequotetemplatehistorychanges) | The set of changes in the negotiable quote template. | -| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote entry was created. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | +| `name` - [`String`](#string) | The name part of the key/value pair. | +| `value` - [`String`](#string) | The value part of the key/value pair. | #### Example ```json { - "author": NegotiableQuoteUser, - "change_type": "CREATED", - "changes": NegotiableQuoteTemplateHistoryChanges, - "created_at": "xyz789", - "uid": "4" + "name": "abc123", + "value": "abc123" } ``` -### NegotiableQuoteTemplateHistoryStatusChange +### LineItemNoteInput -Lists a new status change applied to a negotiable quote template and the previous status. +Sets quote item note. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `new_status` - [`String!`](#string) | The updated status. | -| `old_status` - [`String`](#string) | The previous status. The value will be null for the first history entry in a negotiable quote. | +| Input Field | Description | +|-------------|-------------| +| `note` - [`String`](#string) | The note text to be added. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json { - "new_status": "abc123", - "old_status": "abc123" + "note": "xyz789", + "quote_item_uid": "4", + "quote_uid": "4" } ``` -### NegotiableQuoteTemplateHistoryStatusesChange +### MediaGalleryInterface -Contains a list of status changes that occurred for the negotiable quote template. +Contains basic information about a product image or video. #### Fields | Field Name | Description | |------------|-------------| -| `changes` - [`[NegotiableQuoteTemplateHistoryStatusChange]!`](#negotiablequotetemplatehistorystatuschange) | A list of status changes. | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | + +#### Possible Types + +| MediaGalleryInterface Types | +|----------------| +| [`AssetImage`](#assetimage) | +| [`AssetVideo`](#assetvideo) | +| [`ProductImage`](#productimage) | +| [`ProductVideo`](#productvideo) | #### Example ```json -{"changes": [NegotiableQuoteTemplateHistoryStatusChange]} +{ + "disabled": true, + "label": "xyz789", + "position": 123, + "url": "xyz789" +} ``` -### NegotiableQuoteTemplateItemQuantityInput +### MediaResourceType -Specifies the updated quantity of an item. +Enumeration of media resource types -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | -| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | +| Enum Value | Description | +|------------|-------------| +| `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 ```json -{ - "item_id": "4", - "max_qty": 123.45, - "min_qty": 123.45, - "quantity": 123.45 -} +""NEGOTIABLE_QUOTE_ATTACHMENT"" ``` -### NegotiableQuoteTemplateReferenceDocumentLinkInput +### MessageStyleLogo -Defines the reference document link to add to a negotiable quote template. +#### Fields -#### Input Fields +| Field Name | Description | +|------------|-------------| +| `type` - [`String`](#string) | The type of logo for the PayPal Pay Later messaging | -| Input Field | Description | -|-------------|-------------| -| `document_identifier` - [`String`](#string) | The identifier of the reference document. | -| `document_name` - [`String!`](#string) | The title of the reference document. | -| `link_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | -| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | +#### Example + +```json +{"type": "xyz789"} +``` + + + +### MessageStyles + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `layout` - [`String`](#string) | The message layout | +| `logo` - [`MessageStyleLogo`](#messagestylelogo) | The message logo | #### Example ```json { - "document_identifier": "xyz789", - "document_name": "abc123", - "link_id": 4, - "reference_document_url": "abc123" + "layout": "abc123", + "logo": MessageStyleLogo } ``` -### NegotiableQuoteTemplateShippingAddressInput +### Money -Defines shipping addresses for the negotiable quote template. +Defines a monetary value, including a numeric value and a currency code. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | -| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the company user. | +| Field Name | Description | +|------------|-------------| +| `currency` - [`CurrencyEnum`](#currencyenum) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](#float) | A number expressing a monetary value. | #### Example ```json -{ - "address": NegotiableQuoteAddressInput, - "customer_address_uid": 4, - "customer_notes": "abc123" -} +{"currency": "AFN", "value": 987.65} ``` -### NegotiableQuoteTemplateSortInput +### MoveCartItemsToGiftRegistryOutput -Defines the field to use to sort a list of negotiable quotes. +Contains the customer's gift registry and any errors encountered. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry. | +| `status` - [`Boolean!`](#boolean) | Indicates whether the attempt to move the cart items to the gift registry was successful. | +| `user_errors` - [`[GiftRegistryItemsUserError]!`](#giftregistryitemsusererror) | An array of errors encountered while moving items from the cart to the gift registry. | #### Example ```json -{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} +{ + "gift_registry": GiftRegistry, + "status": false, + "user_errors": [GiftRegistryItemsUserError] +} ``` -### NegotiableQuoteTemplateSortableField +### MoveItemsBetweenRequisitionListsInput -#### Values +An input object that defines the items in a requisition list to be moved. -| Enum Value | Description | -|------------|-------------| -| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | -| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `requisitionListItemUids` - [`[ID]!`](#id) | An array of IDs representing products moved from one requisition list to another. | #### Example ```json -""TEMPLATE_ID"" +{"requisitionListItemUids": [4]} ``` -### NegotiableQuoteTemplatesOutput +### MoveItemsBetweenRequisitionListsOutput -Contains a list of negotiable templates that match the specified filter. +Output of the request to move items to another requisition list. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | +| `destination_requisition_list` - [`RequisitionList`](#requisitionlist) | The destination requisition list after moving items. | +| `source_requisition_list` - [`RequisitionList`](#requisitionlist) | The source requisition list after moving items. | #### Example ```json { - "items": [NegotiableQuoteTemplateGridItem], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 987 + "destination_requisition_list": RequisitionList, + "source_requisition_list": RequisitionList } ``` -### NegotiableQuoteUidNonFatalResultInterface - -#### Fields +### MoveLineItemToRequisitionListInput -| Field Name | Description | -|------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +Move Line Item to Requisition List. -#### Possible Types +#### Input Fields -| NegotiableQuoteUidNonFatalResultInterface Types | -|----------------| -| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | +| Input Field | Description | +|-------------|-------------| +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartLineItem` object. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `requisition_list_uid` - [`ID!`](#id) | The unique ID of a requisition list. | #### Example ```json -{"quote_uid": "4"} +{ + "quote_item_uid": "4", + "quote_uid": "4", + "requisition_list_uid": "4" +} ``` -### NegotiableQuoteUidOperationSuccess +### MoveLineItemToRequisitionListOutput -Contains details about a successful operation on a negotiable quote. +Contains the updated negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after moving item to requisition list. | #### Example ```json -{"quote_uid": 4} +{"quote": NegotiableQuote} ``` -### NegotiableQuoteUser +### MoveProductsBetweenWishlistsOutput -A limited view of a Buyer or Seller in the negotiable quote process. +Contains the source and target wish lists after moving products. #### Fields | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | -| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | +| `destination_wishlist` - [`Wishlist!`](#wishlist) | The destination wish list after receiving products moved from the source wish list. | +| `source_wishlist` - [`Wishlist!`](#wishlist) | The source wish list after moving products from it. | +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while moving products to a wish list. | #### Example ```json { - "firstname": "abc123", - "lastname": "xyz789" + "destination_wishlist": Wishlist, + "source_wishlist": Wishlist, + "user_errors": [WishListUserInputError] } ``` -### NegotiableQuotesOutput +### NegotiableQuote -Contains a list of negotiable that match the specified filter. +Contains details about a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | -| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | +| `available_payment_methods` - [`[AvailablePaymentMethod]`](#availablepaymentmethod) | An array of payment methods that can be applied to the negotiable quote. | +| `billing_address` - [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | The billing address applied to the negotiable quote. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was created. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the negotiable quote | +| `email` - [`String`](#string) | The email address of the company user. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote. | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote. | +| `order` - [`CustomerOrder`](#customerorder) | The order created from the negotiable quote. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `selected_payment_method` - [`SelectedPaymentMethod`](#selectedpaymentmethod) | The payment method that was applied to the negotiable quote. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote. | +| `status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The status of the negotiable quote. | +| `template_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `template_name` - [`String`](#string) | The title assigned to the negotiable quote template. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `updated_at` - [`String`](#string) | Timestamp indicating when the negotiable quote was updated. | #### Example ```json { - "items": [NegotiableQuote], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 123 + "available_payment_methods": [AvailablePaymentMethod], + "billing_address": NegotiableQuoteBillingAddress, + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "created_at": "xyz789", + "custom_attributes": [CustomAttribute], + "email": "abc123", + "expiration_date": "xyz789", + "history": [NegotiableQuoteHistoryEntry], + "is_virtual": true, + "items": [CartItemInterface], + "name": "xyz789", + "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": 987.65, + "uid": 4, + "updated_at": "xyz789" } ``` -### NoSuchEntityUidError +### NegotiableQuoteAddressCountry -Contains an error message when an invalid UID was specified. +Defines the company's country. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | +| `code` - [`String!`](#string) | The address country code. | +| `label` - [`String!`](#string) | The display name of the region. | #### Example ```json { - "message": "abc123", - "uid": "4" + "code": "xyz789", + "label": "xyz789" } ``` -### NumericOperatorInput +### NegotiableQuoteAddressInput + +Defines the billing or shipping address to be applied to the cart. #### Input Fields | Input Field | Description | |-------------|-------------| -| `type` - [`NumericOperatorType`](#numericoperatortype) | | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company name. | +| `country_code` - [`String!`](#string) | The country code and label for the billing or shipping address. | +| `custom_attributes` - [`[AttributeValueInput]`](#attributevalueinput) | The custom attribute values of the billing or shipping negotiable quote address. | +| `fax` - [`String`](#string) | The fax number of the customer. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | A string that defines the state or province of the billing or shipping address. | +| `region_id` - [`Int`](#int) | An integer that defines the state or province of the billing or shipping address. | +| `save_in_address_book` - [`Boolean`](#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json -{"type": "UNKNOWN_NUMERIC_OPERATOR"} +{ + "city": "xyz789", + "company": "xyz789", + "country_code": "xyz789", + "custom_attributes": [AttributeValueInput], + "fax": "abc123", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", + "region": "abc123", + "region_id": 123, + "save_in_address_book": false, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "abc123" +} ``` -### NumericOperatorType +### NegotiableQuoteAddressInterface -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `UNKNOWN_NUMERIC_OPERATOR` | | -| `GREATER_THAN_CURRENT` | | -| `LESS_THAN_CURRENT` | | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](#string) | The fax number of the customer. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `uid` - [`ID!`](#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | + +#### Possible Types + +| NegotiableQuoteAddressInterface Types | +|----------------| +| [`NegotiableQuoteBillingAddress`](#negotiablequotebillingaddress) | +| [`NegotiableQuoteShippingAddress`](#negotiablequoteshippingaddress) | #### Example ```json -""UNKNOWN_NUMERIC_OPERATOR"" +{ + "city": "xyz789", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": 4, + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "xyz789", + "prefix": "abc123", + "region": NegotiableQuoteAddressRegion, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": "4", + "vat_id": "abc123" +} ``` -### OopePaymentMethodConfig +### NegotiableQuoteAddressRegion + +Defines the company's state or province. #### Fields | Field Name | Description | |------------|-------------| -| `backend_integration_url` - [`String!`](#string) | The backend URL to dispatch requests related to the payment method. | -| `custom_config` - [`[CustomConfigKeyValue]!`](#customconfigkeyvalue) | Custom config key values. | +| `code` - [`String`](#string) | The address region code. | +| `label` - [`String`](#string) | The display name of the region. | +| `region_id` - [`Int`](#int) | The unique ID for a pre-defined region. | #### Example ```json { - "backend_integration_url": "abc123", - "custom_config": [CustomConfigKeyValue] -} + "code": "xyz789", + "label": "xyz789", + "region_id": 987 +} ``` -### OpenNegotiableQuoteTemplateInput +### NegotiableQuoteBillingAddress -Specifies the quote template id to open quote template. +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](#string) | The fax number of the customer. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `uid` - [`ID!`](#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | + +#### Example + +```json +{ + "city": "abc123", + "company": "xyz789", + "country": NegotiableQuoteAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": 4, + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "xyz789", + "region": NegotiableQuoteAddressRegion, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": 4, + "vat_id": "abc123" +} +``` + + + +### NegotiableQuoteBillingAddressInput + +Defines the billing address. #### Input Fields | Input Field | Description | |-------------|-------------| -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | Defines a billing address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID of a `CustomerAddress` object. | +| `same_as_shipping` - [`Boolean`](#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`](#boolean) | Indicates whether to set the shipping address to be the same as this billing address. | #### Example ```json -{"template_id": "4"} +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": 4, + "same_as_shipping": true, + "use_for_shipping": false +} ``` -### OperatorInput +### NegotiableQuoteComment -#### Input Fields +Contains a single plain text comment from either the buyer or seller. -| Input Field | Description | -|-------------|-------------| -| `rangeOperator` - [`RangeOperatorInput`](#rangeoperatorinput) | | -| `customOperator` - [`CustomOperatorInput`](#customoperatorinput) | | -| `isOperator` - [`IsOperatorInput`](#isoperatorinput) | | -| `numericOperator` - [`NumericOperatorInput`](#numericoperatorinput) | | -| `stringOperator` - [`StringOperatorInput`](#stringoperatorinput) | | +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attachments` - [`[NegotiableQuoteCommentAttachment]!`](#negotiablequotecommentattachment) | Negotiable quote comment file attachments. | +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the commenter. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the comment was created. | +| `creator_type` - [`NegotiableQuoteCommentCreatorType!`](#negotiablequotecommentcreatortype) | Indicates whether a buyer or seller commented. | +| `text` - [`String!`](#string) | The plain text comment. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteComment` object. | #### Example ```json { - "rangeOperator": RangeOperatorInput, - "customOperator": CustomOperatorInput, - "isOperator": IsOperatorInput, - "numericOperator": NumericOperatorInput, - "stringOperator": StringOperatorInput + "attachments": [NegotiableQuoteCommentAttachment], + "author": NegotiableQuoteUser, + "created_at": "abc123", + "creator_type": "BUYER", + "text": "xyz789", + "uid": 4 } ``` -### Order +### NegotiableQuoteCommentAttachment -Contains the order ID. +Negotiable quote comment file attachment. #### Fields | Field Name | Description | |------------|-------------| -| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | +| `name` - [`String!`](#string) | Negotiable quote comment attachment file name. | +| `url` - [`String!`](#string) | Negotiable quote comment attachment file url. | #### Example ```json -{"order_number": "abc123"} +{ + "name": "xyz789", + "url": "abc123" +} ``` -### OrderActionType +### NegotiableQuoteCommentAttachmentInput -The list of available order actions. +Negotiable quote comment file attachment. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `key` - [`String!`](#string) | Negotiable quote comment attachment file key. | + +#### Example + +```json +{"key": "abc123"} +``` + + + +### NegotiableQuoteCommentCreatorType #### Values | Enum Value | Description | |------------|-------------| -| `REORDER` | | -| `CANCEL` | | -| `RETURN` | | +| `BUYER` | | +| `SELLER` | | #### Example ```json -""REORDER"" +""BUYER"" ``` -### OrderAddress +### NegotiableQuoteCommentInput -Contains detailed information about an order's billing and shipping addresses. +Contains the commend provided by the buyer. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city or town. | -| `company` - [`String`](#string) | The customer's company. | -| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | -| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | -| `fax` - [`String`](#string) | The fax number. | -| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | -| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | -| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`String`](#string) | The state or province name. | -| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | -| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number. | -| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | +| Input Field | Description | +|-------------|-------------| +| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote comment file attachments. | +| `comment` - [`String!`](#string) | The comment provided by the buyer. | #### Example ```json { - "city": "xyz789", - "company": "xyz789", - "country_code": "AF", - "custom_attributesV2": [AttributeValueInterface], - "fax": "abc123", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "abc123", - "prefix": "xyz789", - "region": "xyz789", - "region_id": "4", - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "abc123" + "attachments": [NegotiableQuoteCommentAttachmentInput], + "comment": "xyz789" } ``` -### OrderCustomerInfo +### NegotiableQuoteCustomLogChange + +Contains custom log entries added by third-party extensions. #### Fields | Field Name | Description | |------------|-------------| -| `firstname` - [`String!`](#string) | First name of the customer | -| `lastname` - [`String`](#string) | Last name of the customer | -| `middlename` - [`String`](#string) | Middle name of the customer | -| `prefix` - [`String`](#string) | Prefix of the customer | -| `suffix` - [`String`](#string) | Suffix of the customer | +| `new_value` - [`String!`](#string) | The new entry content. | +| `old_value` - [`String`](#string) | The previous entry in the custom log. | +| `title` - [`String!`](#string) | The title of the custom log entry. | #### Example ```json { - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "abc123", - "prefix": "xyz789", - "suffix": "xyz789" + "new_value": "abc123", + "old_value": "abc123", + "title": "xyz789" } ``` -### OrderItem +### NegotiableQuoteFilterInput -#### Fields +Defines a filter to limit the negotiable quotes to return. -| Field Name | Description | -|------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `ids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by the ID of one or more negotiable quotes. | +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the negotiable quote name. | #### Example ```json { - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "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": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, - "selected_options": [OrderItemOption], - "status": "abc123" + "ids": FilterEqualTypeInput, + "name": FilterMatchTypeInput } ``` -### OrderItemInterface +### NegotiableQuoteHistoryChanges -Order item details. +Contains a list of changes to a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | -| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | -| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | -| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | -| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | -| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | -| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | -| `product_url_key` - [`String`](#string) | URL key of the base product. | -| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | -| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | -| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | -| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | -| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | -| `quantity_returned` - [`Float`](#float) | The number of returned items. | -| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | -| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | -| `status` - [`String`](#string) | The status of the order item. | - -#### Possible Types - -| OrderItemInterface Types | -|----------------| -| [`BundleOrderItem`](#bundleorderitem) | -| [`ConfigurableOrderItem`](#configurableorderitem) | -| [`DownloadableOrderItem`](#downloadableorderitem) | -| [`GiftCardOrderItem`](#giftcardorderitem) | -| [`OrderItem`](#orderitem) | +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteHistoryStatusesChange`](#negotiablequotehistorystatuseschange) | The status before and after a change in the negotiable quote history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | #### Example ```json { - "custom_attributes": [CustomAttribute], - "discounts": [Discount], - "eligible_for_return": false, - "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": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 987.65, - "selected_options": [OrderItemOption], - "status": "abc123" + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange } ``` -### OrderItemOption +### NegotiableQuoteHistoryCommentChange -Represents order item options like selected or entered. +Contains a comment submitted by a seller or buyer. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String!`](#string) | The name of the option. | -| `value` - [`String!`](#string) | The value of the option. | +| `comment` - [`String!`](#string) | A plain text comment submitted by a seller or buyer. | #### Example ```json -{ - "label": "abc123", - "value": "xyz789" -} +{"comment": "xyz789"} ``` -### OrderItemPrices +### NegotiableQuoteHistoryEntry + +Contains details about a change for a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | -| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | -| `original_price` - [`Money`](#money) | The original price of the item. | -| `original_price_including_tax` - [`Money`](#money) | The original price of the item including tax. | -| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | -| `original_row_total_including_tax` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item including tax. | -| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | -| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | -| `total_item_discount` - [`Money!`](#money) | The total of all discounts applied to the item. | +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | +| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that describes the why the entry in the negotiable quote history changed status. | +| `changes` - [`NegotiableQuoteHistoryChanges`](#negotiablequotehistorychanges) | The set of changes in the negotiable quote. | +| `created_at` - [`String`](#string) | Timestamp indicating when the negotiable quote entry was created. | +| `item_note` - [`HistoryItemNoteData`](#historyitemnotedata) | Item note data that is added to the negotiable quote history object. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example ```json { - "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 + "author": NegotiableQuoteUser, + "change_type": "CREATED", + "changes": NegotiableQuoteHistoryChanges, + "created_at": "xyz789", + "item_note": HistoryItemNoteData, + "uid": "4" } ``` -### OrderPaymentMethod - -Contains details about the payment method used to pay for the order. +### NegotiableQuoteHistoryEntryChangeType -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | -| `name` - [`String!`](#string) | The label that describes the payment method. | -| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | +| `CREATED` | | +| `UPDATED` | | +| `CLOSED` | | +| `UPDATED_BY_SYSTEM` | | #### Example ```json -{ - "additional_data": [KeyValue], - "name": "xyz789", - "type": "abc123" -} +""CREATED"" ``` -### OrderShipment +### NegotiableQuoteHistoryExpirationChange -Contains order shipment details. +Contains a new expiration date and the previous date. #### Fields | Field Name | Description | |------------|-------------| -| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | -| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | -| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | -| `number` - [`String!`](#string) | The sequential credit shipment number. | -| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | +| `new_expiration` - [`String`](#string) | The expiration date after the change. The value will be 'null' if not set. | +| `old_expiration` - [`String`](#string) | The previous expiration date. The value will be 'null' if not previously set. | #### Example ```json { - "comments": [SalesCommentItem], - "id": "4", - "items": [ShipmentItemInterface], - "number": "abc123", - "tracking": [ShipmentTracking] + "new_expiration": "abc123", + "old_expiration": "abc123" } ``` -### OrderTokenInput - -Input to retrieve an order based on token. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{"token": "xyz789"} -``` - - - -### OrderTotal +### NegotiableQuoteHistoryProductsRemovedChange -Contains details about the sales total amounts used to calculate the final price. +Contains lists of products that have been removed from the catalog and negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | -| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | -| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | | -| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | -| `grand_total_excl_tax` - [`Money!`](#money) | The grand total of the order, excluding taxes. | -| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | -| `subtotal_excl_tax` - [`Money!`](#money) | The subtotal of the order, excluding taxes. | -| `subtotal_incl_tax` - [`Money!`](#money) | The subtotal of the order, including taxes. | -| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | -| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | -| `total_reward_points` - [`Money`](#money) | The total reward points applied to the order. | -| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | -| `total_store_credit` - [`Money`](#money) | The total store credit applied to the order. | -| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | +| `products_removed_from_catalog` - [`[ID]`](#id) | A list of product IDs the seller removed from the catalog. | +| `products_removed_from_quote` - [`[ProductInterface]`](#productinterface) | A list of products removed from the negotiable quote by either the buyer or the seller. *(Deprecated: Product information is part of a composable Catalog Service.)* | #### Example ```json { - "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, - "taxes": [TaxItem], - "total_giftcard": Money, - "total_reward_points": Money, - "total_shipping": Money, - "total_store_credit": Money, - "total_tax": Money + "products_removed_from_catalog": ["4"], + "products_removed_from_quote": [ProductInterface] } ``` -### PageType +### NegotiableQuoteHistoryStatusChange -Type of page on which recommendations are requested +Lists a new status change applied to a negotiable quote and the previous status. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `CMS` | | -| `Cart` | | -| `Category` | *(Deprecated: This field is deprecated and will be removed.)* | -| `Checkout` | | -| `PageBuilder` | | -| `Product` | | +| `new_status` - [`NegotiableQuoteStatus!`](#negotiablequotestatus) | The updated status. | +| `old_status` - [`NegotiableQuoteStatus`](#negotiablequotestatus) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json -""CMS"" +{"new_status": "SUBMITTED", "old_status": "SUBMITTED"} ``` -### PaymentAttributeInput +### NegotiableQuoteHistoryStatusesChange -Defines the payment attribute. +Contains a list of status changes that occurred for the negotiable quote. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `key` - [`String!`](#string) | The code of the attribute. | -| `value` - [`String!`](#string) | The value of the attribute. | +| Field Name | Description | +|------------|-------------| +| `changes` - [`[NegotiableQuoteHistoryStatusChange]!`](#negotiablequotehistorystatuschange) | A list of status changes. | #### Example ```json -{ - "key": "abc123", - "value": "abc123" -} +{"changes": [NegotiableQuoteHistoryStatusChange]} ``` -### PaymentConfigItem +### NegotiableQuoteHistoryTotalChange -Contains payment fields that are common to all types of payment methods. +Contains a new price and the previous price. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | - -#### Possible Types - -| PaymentConfigItem Types | -|----------------| -| [`ApplePayConfig`](#applepayconfig) | -| [`FastlaneConfig`](#fastlaneconfig) | -| [`GooglePayConfig`](#googlepayconfig) | -| [`HostedFieldsConfig`](#hostedfieldsconfig) | -| [`SmartButtonsConfig`](#smartbuttonsconfig) | +| `new_price` - [`Money`](#money) | The total price as a result of the change. | +| `old_price` - [`Money`](#money) | The previous total price on the negotiable quote. | #### Example ```json { - "code": "xyz789", - "is_visible": true, - "payment_intent": "abc123", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" + "new_price": Money, + "old_price": Money } ``` -### PaymentConfigOutput +### NegotiableQuoteInvalidStateError -Retrieves the payment configuration for a given location +An error indicating that an operation was attempted on a negotiable quote in an invalid state. #### Fields | Field Name | Description | |------------|-------------| -| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | -| `fastlane` - [`FastlaneConfig`](#fastlaneconfig) | Fastlane payment method configuration | -| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | -| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | -| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | +| `message` - [`String!`](#string) | The returned error message. | #### Example ```json -{ - "apple_pay": ApplePayConfig, - "fastlane": FastlaneConfig, - "google_pay": GooglePayConfig, - "hosted_fields": HostedFieldsConfig, - "smart_buttons": SmartButtonsConfig -} +{"message": "abc123"} ``` -### PaymentLocation +### NegotiableQuoteItemQuantityInput -Defines the origin location for that payment request +Specifies the updated quantity of an item. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `PRODUCT_DETAIL` | | -| `MINICART` | | -| `CART` | | -| `CHECKOUT` | | -| `ADMIN` | | +| Input Field | Description | +|-------------|-------------| +| `quantity` - [`Float!`](#float) | The new quantity of the negotiable quote item. | +| `quote_item_uid` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | #### Example ```json -""PRODUCT_DETAIL"" +{"quantity": 123.45, "quote_item_uid": 4} ``` -### PaymentMethodInput +### NegotiableQuotePaymentMethodInput -Defines the payment method. +Defines the payment method to be applied to the negotiable quote. #### Input Fields | Input Field | Description | |-------------|-------------| -| `additional_data` - [`[PaymentAttributeInput]`](#paymentattributeinput) | Additional data related to the payment method. | -| `code` - [`String!`](#string) | The internal name for the payment method. | -| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | -| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](#fastlanemethodinput) | Required input for fastlane | -| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | -| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | -| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | -| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | +| `code` - [`String!`](#string) | Payment method code | | `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "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, - "payment_services_paypal_vault": VaultMethodInput, - "purchase_order_number": "abc123" + "purchase_order_number": "xyz789" } ``` -### PaymentOrderOutput +### NegotiableQuoteReferenceDocumentLink -Contains the payment order details +Contains a reference document link for a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`String`](#string) | PayPal order ID | -| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | -| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | -| `status` - [`String`](#string) | The status of the payment order | +| `document_identifier` - [`String`](#string) | The identifier of the reference document. | +| `document_name` - [`String!`](#string) | The title of the reference document. | +| `link_id` - [`ID!`](#id) | The unique ID of a reference document link. | +| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | #### Example ```json { - "id": "abc123", - "mp_order_id": "xyz789", - "payment_source_details": PaymentSourceDetails, - "status": "xyz789" + "document_identifier": "xyz789", + "document_name": "xyz789", + "link_id": 4, + "reference_document_url": "xyz789" } ``` -### PaymentSDKParamsItem +### NegotiableQuoteShippingAddress #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String`](#string) | The payment method code used in the order | -| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array of shipping methods available to the buyer. | +| `city` - [`String!`](#string) | The company's city or town. | +| `company` - [`String`](#string) | The company name associated with the shipping/billing address. | +| `country` - [`NegotiableQuoteAddressCountry!`](#negotiablequoteaddresscountry) | The company's country. | +| `custom_attributes` - [`[AttributeValueInterface]`](#attributevalueinterface) | The custom attribute values of the billing or shipping negotiable quote address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `fax` - [`String`](#string) | The fax number of the customer. | +| `firstname` - [`String!`](#string) | The first name of the company user. | +| `lastname` - [`String!`](#string) | The last name of the company user. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `postcode` - [`String`](#string) | The company's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`NegotiableQuoteAddressRegion`](#negotiablequoteaddressregion) | An object containing the region name, region code, and region ID. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | The selected shipping method. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The customer's telephone number. | +| `uid` - [`ID!`](#id) | The unique identifier of the negotiable quote address. | +| `vat_id` - [`String`](#string) | The customer's Tax/VAT number (for corporate customers). | #### Example ```json { - "code": "abc123", - "params": [SDKParams] + "available_shipping_methods": [AvailableShippingMethod], + "city": "xyz789", + "company": "abc123", + "country": NegotiableQuoteAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": "4", + "fax": "abc123", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", + "region": NegotiableQuoteAddressRegion, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", + "uid": 4, + "vat_id": "xyz789" } ``` -### PaymentSourceDetails +### NegotiableQuoteShippingAddressInput -#### Fields +Defines shipping addresses for the negotiable quote. -| Field Name | Description | -|------------|-------------| -| `card` - [`Card`](#card) | Details about the card used on the order | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json -{"card": Card} +{ + "address": NegotiableQuoteAddressInput, + "customer_address_uid": "4", + "customer_notes": "xyz789" +} ``` -### PaymentSourceInput +### NegotiableQuoteSortInput -The payment source information +Defines the field to use to sort a list of negotiable quotes. #### Input Fields | Input Field | Description | |-------------|-------------| -| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteSortableField!`](#negotiablequotesortablefield) | The specified sort field. | #### Example ```json -{"card": CardPaymentSourceInput} +{"sort_direction": "ASC", "sort_field": "QUOTE_NAME"} ``` -### PaymentSourceOutput +### NegotiableQuoteSortableField -The payment source information +#### Values -#### Fields +| Enum Value | Description | +|------------|-------------| +| `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. | -| Field Name | Description | +#### Example + +```json +""QUOTE_NAME"" +``` + + + +### NegotiableQuoteStatus + +#### Values + +| Enum Value | Description | |------------|-------------| -| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | +| `SUBMITTED` | | +| `PENDING` | | +| `UPDATED` | | +| `OPEN` | | +| `ORDERED` | | +| `CLOSED` | | +| `DECLINED` | | +| `EXPIRED` | | +| `DRAFT` | | #### Example ```json -{"card": CardPaymentSourceOutput} +""SUBMITTED"" ``` -### PaymentToken +### NegotiableQuoteTemplate -The stored payment method available to the customer. +Contains details about a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `details` - [`String`](#string) | A description of the stored account details. | -| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | -| `public_hash` - [`String!`](#string) | The public hash of the token. | -| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | +| `buyer` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The first and last name of the buyer. | +| `comments` - [`[NegotiableQuoteComment]`](#negotiablequotecomment) | A list of comments made by the buyer and seller. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `history` - [`[NegotiableQuoteHistoryEntry]`](#negotiablequotehistoryentry) | A list of status and price changes for the negotiable quote template. | +| `historyV2` - [`[NegotiableQuoteTemplateHistoryEntry]`](#negotiablequotetemplatehistoryentry) | | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `is_virtual` - [`Boolean!`](#boolean) | Indicates whether the negotiable quote template contains only virtual products. | +| `items` - [`[CartItemInterface]`](#cartiteminterface) | The list of items in the negotiable quote template. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `notifications` - [`[QuoteTemplateNotificationMessage]`](#quotetemplatenotificationmessage) | A list of notifications for the negotiable quote template. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `reference_document_links` - [`[NegotiableQuoteReferenceDocumentLink]`](#negotiablequotereferencedocumentlink) | A list of reference document links for the negotiable quote template. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddress]!`](#negotiablequoteshippingaddress) | A list of shipping addresses applied to the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `total_quantity` - [`Float!`](#float) | The total number of items in the negotiable quote template. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was updated. | #### Example ```json { - "details": "xyz789", - "payment_method_code": "xyz789", - "public_hash": "xyz789", - "type": "card" + "buyer": NegotiableQuoteUser, + "comments": [NegotiableQuoteComment], + "created_at": "abc123", + "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": 987, + "name": "xyz789", + "notifications": [QuoteTemplateNotificationMessage], + "prices": CartPrices, + "reference_document_links": [ + NegotiableQuoteReferenceDocumentLink + ], + "sales_rep_name": "abc123", + "shipping_addresses": [NegotiableQuoteShippingAddress], + "status": "xyz789", + "template_id": "4", + "total_quantity": 123.45, + "uid": 4, + "updated_at": "abc123" } ``` -### PaymentTokenTypeEnum +### NegotiableQuoteTemplateFilterInput -The list of available payment token types. +Defines a filter to limit the negotiable quotes to return. -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | -| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| Input Field | Description | +|-------------|-------------| +| `state` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by state of one or more negotiable quote templates. | +| `status` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter by status of one or more negotiable quote templates. | #### Example ```json -""card"" +{ + "state": FilterEqualTypeInput, + "status": FilterEqualTypeInput +} ``` -### PhysicalProductInterface +### NegotiableQuoteTemplateGridItem -Contains attributes specific to tangible products. +Contains data for a negotiable quote template in a grid. #### Fields | Field Name | Description | |------------|-------------| -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | - -#### Possible Types - -| PhysicalProductInterface Types | -|----------------| -| [`BundleProduct`](#bundleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`SimpleProduct`](#simpleproduct) | +| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | +| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_ordered_at` - [`String!`](#string) | Timestamp indicating when the last negotiable quote template order was placed. | +| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `state` - [`String!`](#string) | State of the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was updated. | #### Example ```json -{"weight": 123.45} +{ + "activated_at": "xyz789", + "company_name": "xyz789", + "created_at": "abc123", + "expiration_date": "abc123", + "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_order_commitment": 987, + "name": "xyz789", + "orders_placed": 987, + "prices": CartPrices, + "sales_rep_name": "xyz789", + "state": "abc123", + "status": "xyz789", + "submitted_by": "abc123", + "template_id": 4, + "uid": "4", + "updated_at": "xyz789" +} ``` -### PickupLocation +### NegotiableQuoteTemplateHistoryChanges -Defines Pickup Location information. +Contains a list of changes to a negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `city` - [`String`](#string) | | -| `contact_name` - [`String`](#string) | | -| `country_id` - [`String`](#string) | | -| `description` - [`String`](#string) | | -| `email` - [`String`](#string) | | -| `fax` - [`String`](#string) | | -| `latitude` - [`Float`](#float) | | -| `longitude` - [`Float`](#float) | | -| `name` - [`String`](#string) | | -| `phone` - [`String`](#string) | | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | | -| `region` - [`String`](#string) | | -| `region_id` - [`Int`](#int) | | -| `street` - [`String`](#string) | | +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteTemplateHistoryStatusesChange`](#negotiablequotetemplatehistorystatuseschange) | The status before and after a change in the negotiable quote template history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | #### Example ```json { - "city": "xyz789", - "contact_name": "abc123", - "country_id": "abc123", - "description": "abc123", - "email": "xyz789", - "fax": "abc123", - "latitude": 123.45, - "longitude": 123.45, - "name": "abc123", - "phone": "xyz789", - "pickup_location_code": "abc123", - "postcode": "xyz789", - "region": "abc123", - "region_id": 987, - "street": "abc123" + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteTemplateHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange } ``` -### PickupLocationFilterInput +### NegotiableQuoteTemplateHistoryEntry -PickupLocationFilterInput defines the list of attributes and filters for the search. +Contains details about a change for a negotiable quote template. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | -| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | -| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | -| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | -| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | -| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | -| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | -| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | +| Field Name | Description | +|------------|-------------| +| `author` - [`NegotiableQuoteUser!`](#negotiablequoteuser) | The person who made a change in the status of the negotiable quote. | +| `change_type` - [`NegotiableQuoteHistoryEntryChangeType!`](#negotiablequotehistoryentrychangetype) | An enum that specifies the reason for a status change in the negotiable quote history entry. | +| `changes` - [`NegotiableQuoteTemplateHistoryChanges`](#negotiablequotetemplatehistorychanges) | The set of changes in the negotiable quote template. | +| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote entry was created. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteHistoryEntry` object. | #### Example ```json { - "city": FilterTypeInput, - "country_id": FilterTypeInput, - "name": FilterTypeInput, - "pickup_location_code": FilterTypeInput, - "postcode": FilterTypeInput, - "region": FilterTypeInput, - "region_id": FilterTypeInput, - "street": FilterTypeInput + "author": NegotiableQuoteUser, + "change_type": "CREATED", + "changes": NegotiableQuoteTemplateHistoryChanges, + "created_at": "abc123", + "uid": 4 } ``` -### PickupLocationSortInput +### NegotiableQuoteTemplateHistoryStatusChange -PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. +Lists a new status change applied to a negotiable quote template and the previous status. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | -| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | -| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | -| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | -| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | -| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | -| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | -| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | -| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | -| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | -| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | -| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | -| `region` - [`SortEnum`](#sortenum) | Name of the region. | -| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | -| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | +| Field Name | Description | +|------------|-------------| +| `new_status` - [`String!`](#string) | The updated status. | +| `old_status` - [`String`](#string) | The previous status. The value will be null for the first history entry in a negotiable quote. | #### Example ```json { - "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" + "new_status": "xyz789", + "old_status": "xyz789" } ``` -### PickupLocations +### NegotiableQuoteTemplateHistoryStatusesChange -Top level object returned in a pickup locations search. +Contains a list of status changes that occurred for the negotiable quote template. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | -| `total_count` - [`Int`](#int) | The number of products returned. | +| `changes` - [`[NegotiableQuoteTemplateHistoryStatusChange]!`](#negotiablequotetemplatehistorystatuschange) | A list of status changes. | #### Example ```json -{ - "items": [PickupLocation], - "page_info": SearchResultPageInfo, - "total_count": 123 -} +{"changes": [NegotiableQuoteTemplateHistoryStatusChange]} ``` -### PlaceNegotiableQuoteOrderInput +### NegotiableQuoteTemplateItemQuantityInput -Specifies the negotiable quote to convert to an order. +Specifies the updated quantity of an item. #### Input Fields | Input Field | Description | |-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `item_id` - [`ID!`](#id) | The unique ID of a `CartItemInterface` object. | +| `max_qty` - [`Float`](#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`](#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!`](#float) | The new quantity of the negotiable quote item. | #### Example ```json -{"quote_uid": "4"} +{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 123.45} ``` -### PlaceNegotiableQuoteOrderOutput +### NegotiableQuoteTemplateReferenceDocumentLinkInput -An output object that returns the generated order. +Defines the reference document link to add to a negotiable quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `order` - [`Order!`](#order) | Contains the generated order number. | +| Input Field | Description | +|-------------|-------------| +| `document_identifier` - [`String`](#string) | The identifier of the reference document. | +| `document_name` - [`String!`](#string) | The title of the reference document. | +| `link_id` - [`ID`](#id) | The unique ID of a `NegotiableQuoteReferenceDocumentLink` object. | +| `reference_document_url` - [`String!`](#string) | The URL of the reference document. | #### Example ```json -{"order": Order} +{ + "document_identifier": "xyz789", + "document_name": "abc123", + "link_id": "4", + "reference_document_url": "abc123" +} ``` -### PlaceNegotiableQuoteOrderOutputV2 +### NegotiableQuoteTemplateShippingAddressInput -An output object that returns the generated order. +Defines shipping addresses for the negotiable quote template. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place negotiable quote order errors. | -| `order` - [`CustomerOrder`](#customerorder) | Full order information. | +| Input Field | Description | +|-------------|-------------| +| `address` - [`NegotiableQuoteAddressInput`](#negotiablequoteaddressinput) | A shipping address. | +| `customer_address_uid` - [`ID`](#id) | An ID from the company user's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the company user. | #### Example ```json { - "errors": [PlaceOrderError], - "order": CustomerOrder + "address": NegotiableQuoteAddressInput, + "customer_address_uid": 4, + "customer_notes": "abc123" } ``` -### PlaceOrderError +### NegotiableQuoteTemplateSortInput -An error encountered while placing an order. +Defines the field to use to sort a list of negotiable quotes. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | -| `message` - [`String!`](#string) | A localized error message. | +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum!`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`NegotiableQuoteTemplateSortableField!`](#negotiablequotetemplatesortablefield) | The specified sort field. | #### Example ```json -{ - "code": "CART_NOT_FOUND", - "message": "xyz789" -} +{"sort_direction": "ASC", "sort_field": "TEMPLATE_ID"} ``` -### PlaceOrderErrorCodes +### NegotiableQuoteTemplateSortableField #### Values | Enum Value | Description | |------------|-------------| -| `CART_NOT_FOUND` | | -| `CART_NOT_ACTIVE` | | -| `GUEST_EMAIL_MISSING` | | -| `UNABLE_TO_PLACE_ORDER` | | -| `UNDEFINED` | | - -#### Example - -```json -""CART_NOT_FOUND"" -``` - - - -### PlaceOrderForPurchaseOrderInput - -Specifies the purchase order to convert to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | +| `TEMPLATE_ID` | Sorts negotiable quote templates by template id. | +| `LAST_SHARED_AT` | Sorts negotiable quote templates by the date they were last shared. | #### Example ```json -{"purchase_order_uid": 4} +""TEMPLATE_ID"" ``` -### PlaceOrderForPurchaseOrderOutput +### NegotiableQuoteTemplatesOutput -Contains the results of the request to place an order. +Contains a list of negotiable templates that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | - -#### Example - -```json -{"order": CustomerOrder} -``` - - - -### PlaceOrderInput - -Specifies the quote to be converted to an order. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `items` - [`[NegotiableQuoteTemplateGridItem]!`](#negotiablequotetemplategriditem) | A list of negotiable quote templates | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quote templates returned | #### Example ```json -{"cart_id": "abc123"} +{ + "items": [NegotiableQuoteTemplateGridItem], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 +} ``` -### PlaceOrderOutput - -Contains the results of the request to place an order. +### NegotiableQuoteUidNonFatalResultInterface #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | -| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | - -#### Example - -```json -{ - "errors": [PlaceOrderError], - "orderV2": CustomerOrder -} -``` - - - -### PlacePurchaseOrderInput - -Specifies the quote to be converted to a purchase order. +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| NegotiableQuoteUidNonFatalResultInterface Types | +|----------------| +| [`NegotiableQuoteUidOperationSuccess`](#negotiablequoteuidoperationsuccess) | #### Example ```json -{"cart_id": "abc123"} +{"quote_uid": 4} ``` -### PlacePurchaseOrderOutput +### NegotiableQuoteUidOperationSuccess -Contains the results of the request to place a purchase order. +Contains details about a successful operation on a negotiable quote. #### Fields | Field Name | Description | |------------|-------------| -| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{"purchase_order": PurchaseOrder} +{"quote_uid": "4"} ``` -### Price +### NegotiableQuoteUser -Defines the price of a simple product or a part of a price range for a complex product. It can include a list of price adjustments. +A limited view of a Buyer or Seller in the negotiable quote process. #### Fields | Field Name | Description | |------------|-------------| -| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | The signed value of the price adjustment (positive for markup, negative for markdown). | -| `amount` - [`ProductViewMoney`](#productviewmoney) | Contains the monetary value and currency code of a product. | +| `firstname` - [`String!`](#string) | The first name of the buyer or seller making a change. | +| `lastname` - [`String!`](#string) | The buyer's or seller's last name. | #### Example ```json { - "adjustments": [PriceAdjustment], - "amount": ProductViewMoney + "firstname": "xyz789", + "lastname": "abc123" } ``` -### PriceAdjustment +### NegotiableQuotesOutput -Specifies the amount and type of price adjustment. +Contains a list of negotiable that match the specified filter. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Float`](#float) | The amount of the price adjustment. | -| `code` - [`String`](#string) | Identifies the type of price adjustment. | +| `items` - [`[NegotiableQuote]!`](#negotiablequote) | A list of negotiable quotes | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int!`](#int) | The number of negotiable quotes returned | #### Example ```json -{"amount": 123.45, "code": "abc123"} +{ + "items": [NegotiableQuote], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 +} ``` -### PriceDetails +### NoSuchEntityUidError -Can be used to retrieve the main price details in case of bundle product +Contains an error message when an invalid UID was specified. #### Fields | Field Name | Description | |------------|-------------| -| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | -| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | -| `main_price` - [`Float`](#float) | The regular price of the main product | +| `message` - [`String!`](#string) | The returned error message. | +| `uid` - [`ID!`](#id) | The specified invalid unique ID of an object. | #### Example ```json { - "discount_percentage": 123.45, - "main_final_price": 987.65, - "main_price": 987.65 + "message": "xyz789", + "uid": "4" } ``` -### PriceRange - -Contains the price range for a product. If the product has a single price, the minimum and maximum price will be the same. +### NumericOperatorInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | -| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | +| Input Field | Description | +|-------------|-------------| +| `type` - [`NumericOperatorType`](#numericoperatortype) | | #### Example ```json -{ - "maximum_price": ProductPrice, - "minimum_price": ProductPrice -} +{"type": "UNKNOWN_NUMERIC_OPERATOR"} ``` -### PriceTypeEnum - -Defines the price type. +### NumericOperatorType #### Values | Enum Value | Description | |------------|-------------| -| `FIXED` | | -| `PERCENT` | | -| `DYNAMIC` | | +| `UNKNOWN_NUMERIC_OPERATOR` | | +| `GREATER_THAN_CURRENT` | | +| `LESS_THAN_CURRENT` | | #### Example ```json -""FIXED"" +""UNKNOWN_NUMERIC_OPERATOR"" ``` -### PriceViewEnum - -Defines whether a bundle product's price is displayed as the lowest possible value or as a range. +### OopePaymentMethodConfig -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `PRICE_RANGE` | | -| `AS_LOW_AS` | | +| `backend_integration_url` - [`String!`](#string) | The backend URL to dispatch requests related to the payment method. | +| `custom_config` - [`[CustomConfigKeyValue]!`](#customconfigkeyvalue) | Custom config key values. | #### Example ```json -""PRICE_RANGE"" +{ + "backend_integration_url": "xyz789", + "custom_config": [CustomConfigKeyValue] +} ``` -### ProductAlertPriceInput +### OpenNegotiableQuoteTemplateInput + +Specifies the quote template id to open quote template. #### Input Fields | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | #### Example ```json -{"sku": "abc123"} +{"template_id": "4"} ``` -### ProductAlertStockInput +### OperatorInput #### Input Fields | Input Field | Description | |-------------|-------------| -| `sku` - [`String!`](#string) | | +| `rangeOperator` - [`RangeOperatorInput`](#rangeoperatorinput) | | +| `customOperator` - [`CustomOperatorInput`](#customoperatorinput) | | +| `isOperator` - [`IsOperatorInput`](#isoperatorinput) | | +| `numericOperator` - [`NumericOperatorInput`](#numericoperatorinput) | | +| `stringOperator` - [`StringOperatorInput`](#stringoperatorinput) | | #### Example ```json -{"sku": "abc123"} +{ + "rangeOperator": RangeOperatorInput, + "customOperator": CustomOperatorInput, + "isOperator": IsOperatorInput, + "numericOperator": NumericOperatorInput, + "stringOperator": StringOperatorInput +} ``` -### ProductAlertSubscriptionResult +### Order + +Contains the order ID. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | | -| `success` - [`Boolean!`](#boolean) | | +| `order_number` - [`String!`](#string) | The unique ID for an `Order` object. | #### Example ```json -{"message": "abc123", "success": true} +{"order_number": "abc123"} ``` -### ProductAttribute +### OrderActionType -Contains a product attribute code and value. +The list of available order actions. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | -| `value` - [`String!`](#string) | The display value of the attribute. | +| `REORDER` | | +| `CANCEL` | | +| `RETURN` | | #### Example ```json -{ - "code": "abc123", - "value": "abc123" -} +""REORDER"" ``` -### ProductAttributeFile +### OrderAddress + +Contains detailed information about an order's billing and shipping addresses. #### Fields | Field Name | Description | |------------|-------------| -| `attribute_type` - [`String`](#string) | Attribute type code. | -| `code` - [`ID!`](#id) | The attribute code. | -| `url` - [`String!`](#string) | Public URL to download the file. | -| `value` - [`String!`](#string) | Stored filename only (e.g. file_xyz.pdf). Use url for download. | +| `city` - [`String!`](#string) | The city or town. | +| `company` - [`String`](#string) | The customer's company. | +| `country_code` - [`CountryCodeEnum`](#countrycodeenum) | The customer's country. | +| `custom_attributesV2` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Custom attributes assigned to the customer address. | +| `fax` - [`String`](#string) | The fax number. | +| `firstname` - [`String!`](#string) | The first name of the person associated with the shipping/billing address. | +| `lastname` - [`String!`](#string) | The family name of the person associated with the shipping/billing address. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the shipping/billing address. | +| `postcode` - [`String`](#string) | The customer's ZIP or postal code. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`String`](#string) | The state or province name. | +| `region_id` - [`ID`](#id) | The unique ID for a `Region` object of a pre-defined region. | +| `street` - [`[String]!`](#string) | An array of strings that define the street number and name. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number. | +| `vat_id` - [`String`](#string) | The customer's Value-added tax (VAT) number (for corporate customers). | #### Example ```json { - "attribute_type": "abc123", - "code": "4", - "url": "abc123", - "value": "xyz789" + "city": "xyz789", + "company": "xyz789", + "country_code": "AF", + "custom_attributesV2": [AttributeValueInterface], + "fax": "abc123", + "firstname": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "xyz789", + "region": "abc123", + "region_id": 4, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "abc123" } ``` -### ProductCustomAttributes +### OrderCustomerInfo -Product custom attributes +#### Fields + +| Field Name | Description | +|------------|-------------| +| `firstname` - [`String!`](#string) | First name of the customer | +| `lastname` - [`String`](#string) | Last name of the customer | +| `middlename` - [`String`](#string) | Middle name of the customer | +| `prefix` - [`String`](#string) | Prefix of the customer | +| `suffix` - [`String`](#string) | Suffix of the customer | + +#### Example + +```json +{ + "firstname": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "prefix": "abc123", + "suffix": "abc123" +} +``` + + + +### OrderItem #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | -| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | #### Example ```json { - "errors": [AttributeMetadataError], - "items": [AttributeValueInterface] + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "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": "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": 123.45, + "quantity_shipped": 987.65, + "selected_options": [OrderItemOption], + "status": "xyz789" } ``` -### ProductDiscount +### OrderItemInterface -Contains the discount applied to a product price. +Order item details. #### Fields | Field Name | Description | |------------|-------------| -| `amount_off` - [`Float`](#float) | The actual value of the discount. | -| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the order item | +| `discounts` - [`[Discount]`](#discount) | The final discount information for the product. | +| `eligible_for_return` - [`Boolean`](#boolean) | Indicates whether the order item is eligible to be in a return request. | +| `entered_options` - [`[OrderItemOption]`](#orderitemoption) | The entered option for the base product, such as a logo or image. | +| `gift_message` - [`GiftMessage`](#giftmessage) | The selected gift message for the order item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the order item. | +| `id` - [`ID!`](#id) | The unique ID for an `OrderItemInterface` object. | +| `prices` - [`OrderItemPrices`](#orderitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface`](#productinterface) | The ProductInterface object, which contains details about the base product *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price of the base product, including selected options. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `product_type` - [`String`](#string) | The type of product, such as simple, configurable, etc. | +| `product_url_key` - [`String`](#string) | URL key of the base product. | +| `quantity_canceled` - [`Float`](#float) | The number of canceled items. | +| `quantity_invoiced` - [`Float`](#float) | The number of invoiced items. | +| `quantity_ordered` - [`Float`](#float) | The number of units ordered for this item. | +| `quantity_refunded` - [`Float`](#float) | The number of refunded items. | +| `quantity_return_requested` - [`Float`](#float) | The requested return quantity of the item. | +| `quantity_returned` - [`Float`](#float) | The number of returned items. | +| `quantity_shipped` - [`Float`](#float) | The number of shipped items. | +| `selected_options` - [`[OrderItemOption]`](#orderitemoption) | The selected options for the base product, such as color or size. | +| `status` - [`String`](#string) | The status of the order item. | + +#### Possible Types + +| OrderItemInterface Types | +|----------------| +| [`BundleOrderItem`](#bundleorderitem) | +| [`ConfigurableOrderItem`](#configurableorderitem) | +| [`DownloadableOrderItem`](#downloadableorderitem) | +| [`GiftCardOrderItem`](#giftcardorderitem) | +| [`OrderItem`](#orderitem) | #### Example ```json -{"amount_off": 123.45, "percent_off": 987.65} +{ + "custom_attributes": [CustomAttribute], + "discounts": [Discount], + "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": "abc123", + "product_type": "abc123", + "product_url_key": "abc123", + "quantity_canceled": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 123.45, + "selected_options": [OrderItemOption], + "status": "xyz789" +} ``` -### ProductImage +### OrderItemOption -Contains product image information, including the image URL and label. +Represents order item options like selected or entered. #### Fields | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | +| `label` - [`String!`](#string) | The name of the option. | +| `value` - [`String!`](#string) | The value of the option. | #### Example ```json { - "disabled": false, - "label": "xyz789", - "position": 123, - "url": "abc123" + "label": "abc123", + "value": "abc123" } ``` -### ProductImageThumbnail +### OrderItemPrices -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `ITSELF` | Use thumbnail of product as image. | -| `PARENT` | Use thumbnail of product's parent as image. | +| `discounts` - [`[Discount]`](#discount) | An array of discounts to be applied to the cart item. | +| `fixed_product_taxes` - [`[FixedProductTax]!`](#fixedproducttax) | | +| `original_price` - [`Money`](#money) | The original price of the item. | +| `original_price_including_tax` - [`Money`](#money) | The original price of the item including tax. | +| `original_row_total` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item. | +| `original_row_total_including_tax` - [`Money!`](#money) | The value of the original price multiplied by the quantity of the item including tax. | +| `price` - [`Money!`](#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!`](#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!`](#money) | The value of the price multiplied by the quantity of the item. | +| `row_total_including_tax` - [`Money!`](#money) | The value of `row_total` plus the tax applied to the item. | +| `total_item_discount` - [`Money!`](#money) | The total of all discounts applied to the item. | #### Example ```json -""ITSELF"" +{ + "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 +} ``` -### ProductInfoInput +### OrderPaymentMethod -Product Information used for Pickup Locations search. +Contains details about the payment method used to pay for the order. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `sku` - [`String!`](#string) | Product SKU. | +| Field Name | Description | +|------------|-------------| +| `additional_data` - [`[KeyValue]`](#keyvalue) | Additional data per payment method type. | +| `name` - [`String!`](#string) | The label that describes the payment method. | +| `type` - [`String!`](#string) | The payment method code that indicates how the order was paid for. | #### Example ```json -{"sku": "abc123"} +{ + "additional_data": [KeyValue], + "name": "abc123", + "type": "abc123" +} ``` -### ProductInterface +### OrderShipment -Contains fields that are common to all types of products. +Contains order shipment details. #### Fields | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | - -#### Possible Types - -| ProductInterface Types | -|----------------| -| [`BundleProduct`](#bundleproduct) | -| [`ConfigurableProduct`](#configurableproduct) | -| [`DownloadableProduct`](#downloadableproduct) | -| [`GiftCardProduct`](#giftcardproduct) | -| [`GroupedProduct`](#groupedproduct) | -| [`SimpleProduct`](#simpleproduct) | -| [`VirtualProduct`](#virtualproduct) | +| `comments` - [`[SalesCommentItem]`](#salescommentitem) | Comments added to the shipment. | +| `id` - [`ID!`](#id) | The unique ID for a `OrderShipment` object. | +| `items` - [`[ShipmentItemInterface]`](#shipmentiteminterface) | An array of items included in the shipment. | +| `number` - [`String!`](#string) | The sequential credit shipment number. | +| `tracking` - [`[ShipmentTracking]`](#shipmenttracking) | An array of shipment tracking details. | #### Example ```json { - "canonical_url": "xyz789", - "categories": [CategoryInterface], - "country_of_manufacture": "abc123", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": false, - "gift_wrapping_price": Money, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options_container": "abc123", - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "related_products": [ProductInterface], - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "abc123", - "thumbnail": ProductImage, - "uid": 4, - "upsell_products": [ProductInterface], - "url_key": "xyz789" + "comments": [SalesCommentItem], + "id": 4, + "items": [ShipmentItemInterface], + "number": "abc123", + "tracking": [ShipmentTracking] } ``` -### ProductLinks +### OrderTokenInput -An implementation of `ProductLinksInterface`. +Input to retrieve an order based on token. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | +| Input Field | Description | +|-------------|-------------| +| `token` - [`String!`](#string) | Order token. | #### Example ```json -{ - "link_type": "abc123", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 987, - "sku": "xyz789" -} +{"token": "abc123"} ``` -### ProductLinksInterface +### OrderTotal -Contains information about linked products, including the link type and product type of each item. +Contains details about the sales total amounts used to calculate the final price. #### Fields | Field Name | Description | |------------|-------------| -| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | -| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | -| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | -| `position` - [`Int`](#int) | The position within the list of product links. | -| `sku` - [`String`](#string) | The identifier of the linked product. | - -#### Possible Types - -| ProductLinksInterface Types | -|----------------| -| [`ProductLinks`](#productlinks) | +| `base_grand_total` - [`Money!`](#money) | The final base grand total amount in the base currency. | +| `discounts` - [`[Discount]`](#discount) | The applied discounts to the order. | +| `gift_options` - [`GiftOptionsPrices`](#giftoptionsprices) | | +| `grand_total` - [`Money!`](#money) | The final total amount, including shipping, discounts, and taxes. | +| `grand_total_excl_tax` - [`Money!`](#money) | The grand total of the order, excluding taxes. | +| `shipping_handling` - [`ShippingHandling`](#shippinghandling) | Details about the shipping and handling costs for the order. | +| `subtotal_excl_tax` - [`Money!`](#money) | The subtotal of the order, excluding taxes. | +| `subtotal_incl_tax` - [`Money!`](#money) | The subtotal of the order, including taxes. | +| `taxes` - [`[TaxItem]`](#taxitem) | The order tax details. | +| `total_giftcard` - [`Money`](#money) | The gift card balance applied to the order. | +| `total_reward_points` - [`Money`](#money) | The total reward points applied to the order. | +| `total_shipping` - [`Money!`](#money) | The shipping amount for the order. | +| `total_store_credit` - [`Money`](#money) | The total store credit applied to the order. | +| `total_tax` - [`Money!`](#money) | The amount of tax applied to the order. | #### Example ```json { - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 123, - "sku": "xyz789" + "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, + "taxes": [TaxItem], + "total_giftcard": Money, + "total_reward_points": Money, + "total_shipping": Money, + "total_store_credit": Money, + "total_tax": Money } ``` -### ProductMediaGalleryEntriesAssetImage +### PageType -Contains basic information about the image asset. +Type of page on which recommendations are requested -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `asset_id` - [`String`](#string) | Asset Id. | -| `media_type` - [`String`](#string) | Must be asset-image. | -| `media_url` - [`String`](#string) | Asset Image Url. | +| `CMS` | | +| `Cart` | | +| `Category` | *(Deprecated: This field is deprecated and will be removed.)* | +| `Checkout` | | +| `PageBuilder` | | +| `Product` | | #### Example ```json -{ - "asset_id": "xyz789", - "media_type": "abc123", - "media_url": "abc123" -} +""CMS"" ``` -### ProductMediaGalleryEntriesAssetVideo +### PaymentAttributeInput -Contains basic information about the video asset. +Defines the payment attribute. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `media_type` - [`String`](#string) | Must be asset-video. | -| `video_asset_id` - [`String`](#string) | Asset Id. | -| `video_media_url` - [`String`](#string) | Asset Video Url. | +| Input Field | Description | +|-------------|-------------| +| `key` - [`String!`](#string) | The code of the attribute. | +| `value` - [`String!`](#string) | The value of the attribute. | #### Example ```json { - "media_type": "xyz789", - "video_asset_id": "abc123", - "video_media_url": "abc123" + "key": "xyz789", + "value": "abc123" } ``` -### ProductMediaGalleryEntriesVideoContent +### PaymentConfigItem -Contains a link to a video file and basic information about the video. +Contains payment fields that are common to all types of payment methods. #### Fields | Field Name | Description | |------------|-------------| -| `media_type` - [`String`](#string) | Must be external-video. | -| `video_description` - [`String`](#string) | A description of the video. | -| `video_metadata` - [`String`](#string) | Optional data about the video. | -| `video_provider` - [`String`](#string) | Describes the video source. | -| `video_title` - [`String`](#string) | The title of the video. | -| `video_url` - [`String`](#string) | The URL to the video. | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Possible Types + +| PaymentConfigItem Types | +|----------------| +| [`ApplePayConfig`](#applepayconfig) | +| [`FastlaneConfig`](#fastlaneconfig) | +| [`GooglePayConfig`](#googlepayconfig) | +| [`HostedFieldsConfig`](#hostedfieldsconfig) | +| [`SmartButtonsConfig`](#smartbuttonsconfig) | #### Example ```json { - "media_type": "xyz789", - "video_description": "abc123", - "video_metadata": "abc123", - "video_provider": "abc123", - "video_title": "abc123", - "video_url": "xyz789" + "code": "abc123", + "is_visible": false, + "payment_intent": "abc123", + "sdk_params": [SDKParams], + "sort_order": "xyz789", + "title": "xyz789" } ``` -### ProductPrice +### PaymentConfigOutput -Represents a product price. +Retrieves the payment configuration for a given location #### Fields | Field Name | Description | |------------|-------------| -| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | -| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | -| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | -| `regular_price` - [`Money!`](#money) | The regular price of the product. | +| `apple_pay` - [`ApplePayConfig`](#applepayconfig) | ApplePay payment method configuration | +| `fastlane` - [`FastlaneConfig`](#fastlaneconfig) | Fastlane payment method configuration | +| `google_pay` - [`GooglePayConfig`](#googlepayconfig) | GooglePay payment method configuration | +| `hosted_fields` - [`HostedFieldsConfig`](#hostedfieldsconfig) | Hosted fields payment method configuration | +| `smart_buttons` - [`SmartButtonsConfig`](#smartbuttonsconfig) | Smart Buttons payment method configuration | #### Example ```json { - "discount": ProductDiscount, - "final_price": Money, - "fixed_product_taxes": [FixedProductTax], - "regular_price": Money -} -``` - - + "apple_pay": ApplePayConfig, + "fastlane": FastlaneConfig, + "google_pay": GooglePayConfig, + "hosted_fields": HostedFieldsConfig, + "smart_buttons": SmartButtonsConfig +} +``` -### ProductSearchItem + -A single product returned by the query +### PaymentLocation -#### Fields +Defines the origin location for that payment request -| Field Name | Description | +#### Values + +| Enum Value | Description | |------------|-------------| -| `applied_query_rule` - [`AppliedQueryRule`](#appliedqueryrule) | The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise) | -| `highlights` - [`[Highlight]`](#highlight) | An object that provides highlighted text for matched words | -| `productView` - [`ProductView`](#productview) | Contains a product view | +| `PRODUCT_DETAIL` | | +| `MINICART` | | +| `CART` | | +| `CHECKOUT` | | +| `ADMIN` | | + +#### Example + +```json +""PRODUCT_DETAIL"" +``` + + + +### PaymentMethodInput + +Defines the payment method. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `additional_data` - [`[PaymentAttributeInput]`](#paymentattributeinput) | Additional data related to the payment method. | +| `code` - [`String!`](#string) | The internal name for the payment method. | +| `payment_services_paypal_apple_pay` - [`ApplePayMethodInput`](#applepaymethodinput) | Required input for Apple Pay button | +| `payment_services_paypal_fastlane` - [`FastlaneMethodInput`](#fastlanemethodinput) | Required input for fastlane | +| `payment_services_paypal_google_pay` - [`GooglePayMethodInput`](#googlepaymethodinput) | Required input for Google Pay button | +| `payment_services_paypal_hosted_fields` - [`HostedFieldsInput`](#hostedfieldsinput) | Required input for Hosted Fields | +| `payment_services_paypal_smart_buttons` - [`SmartButtonMethodInput`](#smartbuttonmethodinput) | Required input for Smart buttons | +| `payment_services_paypal_vault` - [`VaultMethodInput`](#vaultmethodinput) | Required input for vault | +| `purchase_order_number` - [`String`](#string) | The purchase order number. Optional for most payment methods. | #### Example ```json { - "applied_query_rule": AppliedQueryRule, - "highlights": [Highlight], - "productView": ProductView + "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, + "payment_services_paypal_vault": VaultMethodInput, + "purchase_order_number": "abc123" } ``` -### ProductSearchResponse +### PaymentOrderOutput -Contains the output of a `productSearch` query +Contains the payment order details #### Fields | Field Name | Description | |------------|-------------| -| `facets` - [`[Aggregation]`](#aggregation) | Details about the static and dynamic facets relevant to the search | -| `items` - [`[ProductSearchItem]`](#productsearchitem) | An array of products returned by the query | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Information for rendering pages of search results | -| `related_terms` - [`[String]`](#string) | An array of strings that might include merchant-defined synonyms | -| `suggestions` - [`[String]`](#string) | An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query | -| `total_count` - [`Int`](#int) | The total number of products returned that matched the query | -| `warnings` - [`[ProductSearchWarning]`](#productsearchwarning) | An array of warning messages for validation issues (e.g., sort parameter ignored due to missing categoryPath) | +| `id` - [`String`](#string) | PayPal order ID | +| `mp_order_id` - [`String`](#string) | The order ID generated by Payment Services | +| `payment_source_details` - [`PaymentSourceDetails`](#paymentsourcedetails) | Details about the card used on the order | +| `status` - [`String`](#string) | The status of the payment order | #### Example ```json { - "facets": [Aggregation], - "items": [ProductSearchItem], - "page_info": SearchResultPageInfo, - "related_terms": ["abc123"], - "suggestions": ["xyz789"], - "total_count": 987, - "warnings": [ProductSearchWarning] + "id": "xyz789", + "mp_order_id": "abc123", + "payment_source_details": PaymentSourceDetails, + "status": "xyz789" } ``` -### ProductSearchSortInput - -The product attribute to sort on +### PaymentSDKParamsItem -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `attribute` - [`String!`](#string) | The attribute code of a product attribute | -| `direction` - [`SortEnum!`](#sortenum) | ASC (ascending) or DESC (descending) | +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The payment method code used in the order | +| `params` - [`[SDKParams]`](#sdkparams) | The payment SDK parameters | #### Example ```json -{"attribute": "xyz789", "direction": "ASC"} +{ + "code": "xyz789", + "params": [SDKParams] +} ``` -### ProductSearchWarning - -Structured warning with code and message for easier client handling +### PaymentSourceDetails #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`String!`](#string) | Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH) | -| `message` - [`String!`](#string) | Human-readable message describing the warning | +| `card` - [`Card`](#card) | Details about the card used on the order | #### Example ```json -{ - "code": "abc123", - "message": "xyz789" -} +{"card": Card} ``` -### ProductStockStatus +### PaymentSourceInput -This enumeration states whether a product stock status is in stock or out of stock +The payment source information -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `IN_STOCK` | | -| `OUT_OF_STOCK` | | +| Input Field | Description | +|-------------|-------------| +| `card` - [`CardPaymentSourceInput!`](#cardpaymentsourceinput) | The card payment source information | #### Example ```json -""IN_STOCK"" +{"card": CardPaymentSourceInput} ``` -### ProductVideo +### PaymentSourceOutput -Contains information about a product video. +The payment source information #### Fields | Field Name | Description | |------------|-------------| -| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | -| `label` - [`String`](#string) | The label of the product image or video. | -| `position` - [`Int`](#int) | The media item's position after it has been sorted. | -| `url` - [`String`](#string) | The URL of the product image or video. | -| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | +| `card` - [`CardPaymentSourceOutput!`](#cardpaymentsourceoutput) | The card payment source information | #### Example ```json -{ - "disabled": false, - "label": "xyz789", - "position": 987, - "url": "xyz789", - "video_content": ProductMediaGalleryEntriesVideoContent -} +{"card": CardPaymentSourceOutput} ``` -### ProductView +### PaymentToken -Defines the product fields available to the SimpleProductView and ComplexProductView types. +The stored payment method available to the customer. #### Fields | Field Name | Description | |------------|-------------| -| `addToCartAllowed` - [`Boolean`](#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | -| `inStock` - [`Boolean`](#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | -| `lowStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the Only X Left threshold. *(Deprecated: This field is deprecated and will be removed.)* | -| `attributes` - [`[ProductViewAttribute]`](#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | -| `description` - [`String`](#string) | The detailed description of the product. | -| `id` - [`ID!`](#id) | The product ID, generated as a composite key, unique per locale. | -| `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. | -| `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | -| `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | -| `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | -| `metaKeyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `metaTitle` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | Product title for search results listings. | -| `shortDescription` - [`String`](#string) | A summary of the product for search results listings. | -| `inputOptions` - [`[ProductViewInputOption]`](#productviewinputoption) | A list of input options. For example, a text field, a number field or a date field. *(Deprecated: This field is deprecated and will be removed.)* | -| `sku` - [`String`](#string) | A unique code used for identification of a product. | -| `externalId` - [`String`](#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | -| `url` - [`String`](#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | -| `urlKey` - [`String`](#string) | The URL key of the product. This is a unique identifier for the product that is used to create the product's URL. | -| `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. For example, related, up-sell, and cross-sell links. | -| `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | -| `visibility` - [`String`](#string) | Visibility setting of the product | - -#### Possible Types - -| ProductView Types | -|----------------| -| [`ComplexProductView`](#complexproductview) | -| [`SimpleProductView`](#simpleproductview) | +| `details` - [`String`](#string) | A description of the stored account details. | +| `payment_method_code` - [`String!`](#string) | The payment method code associated with the token. | +| `public_hash` - [`String!`](#string) | The public hash of the token. | +| `type` - [`PaymentTokenTypeEnum!`](#paymenttokentypeenum) | Specifies the payment token type. | #### Example ```json { - "addToCartAllowed": false, - "inStock": true, - "lowStock": false, - "attributes": [ProductViewAttribute], - "description": "abc123", - "id": "4", - "images": [ProductViewImage], - "videos": [ProductViewVideo], - "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "xyz789", - "metaTitle": "abc123", - "name": "xyz789", - "shortDescription": "xyz789", - "inputOptions": [ProductViewInputOption], - "sku": "xyz789", - "externalId": "abc123", - "url": "abc123", - "urlKey": "abc123", - "links": [ProductViewLink], - "queryType": "xyz789", - "visibility": "abc123" + "details": "abc123", + "payment_method_code": "abc123", + "public_hash": "xyz789", + "type": "card" } ``` -### ProductViewAttribute +### PaymentTokenTypeEnum -A container for customer-defined attributes that are displayed the storefront. +The list of available payment token types. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `label` - [`String`](#string) | Label of the attribute. | -| `name` - [`String!`](#string) | Name of an attribute code. For example, `color`, `size` or `material` | -| `roles` - [`[String]`](#string) | Roles designated for an attribute on the storefront. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | -| `value` - [`JSON`](#json) | Attribute value, arbitrary of type. For example, `red`, `blue` or `green` | +| `card` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | +| `account` | phpcs:ignore Magento2.GraphQL.ValidArgumentName | #### Example ```json -{ - "label": "xyz789", - "name": "xyz789", - "roles": ["xyz789"], - "value": {} -} +""card"" ``` -### ProductViewCurrency +### PhysicalProductInterface -The list of supported currency codes. +Contains attributes specific to tangible products. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `AED` | | -| `AFN` | | -| `ALL` | | -| `AMD` | | -| `ANG` | | -| `AOA` | | -| `ARS` | | -| `AUD` | | -| `AWG` | | -| `AZM` | | -| `AZN` | | -| `BAM` | | -| `BBD` | | -| `BDT` | | -| `BGN` | | -| `BHD` | | -| `BIF` | | -| `BMD` | | -| `BND` | | -| `BOB` | | -| `BRL` | | -| `BSD` | | -| `BTN` | | -| `BUK` | | -| `BWP` | | -| `BYN` | | -| `BZD` | | -| `CAD` | | -| `CDF` | | -| `CHE` | | -| `CHF` | | -| `CHW` | | -| `CLP` | | -| `CNY` | | -| `COP` | | -| `CRC` | | -| `CUP` | | -| `CVE` | | -| `CZK` | | -| `DJF` | | -| `DKK` | | -| `DOP` | | -| `DZD` | | -| `EEK` | | -| `EGP` | | -| `ERN` | | -| `ETB` | | -| `EUR` | | -| `FJD` | | -| `FKP` | | -| `GBP` | | -| `GEK` | | -| `GEL` | | -| `GHS` | | -| `GIP` | | -| `GMD` | | -| `GNF` | | -| `GQE` | | -| `GTQ` | | -| `GYD` | | -| `HKD` | | -| `HNL` | | -| `HRK` | | -| `HTG` | | -| `HUF` | | -| `IDR` | | -| `ILS` | | -| `INR` | | -| `IQD` | | -| `IRR` | | -| `ISK` | | -| `JMD` | | -| `JOD` | | -| `JPY` | | -| `KES` | | -| `KGS` | | -| `KHR` | | -| `KMF` | | -| `KPW` | | -| `KRW` | | -| `KWD` | | -| `KYD` | | -| `KZT` | | -| `LAK` | | -| `LBP` | | -| `LKR` | | -| `LRD` | | -| `LSL` | | -| `LSM` | | -| `LTL` | | -| `LVL` | | -| `LYD` | | -| `MAD` | | -| `MDL` | | -| `MGA` | | -| `MKD` | | -| `MMK` | | -| `MNT` | | -| `MOP` | | -| `MRO` | | -| `MUR` | | -| `MVR` | | -| `MWK` | | -| `MXN` | | -| `MYR` | | -| `MZN` | | -| `NAD` | | -| `NGN` | | -| `NIC` | | -| `NOK` | | -| `NPR` | | -| `NZD` | | -| `OMR` | | -| `PAB` | | -| `PEN` | | -| `PGK` | | -| `PHP` | | -| `PKR` | | -| `PLN` | | -| `PYG` | | -| `QAR` | | -| `RHD` | | -| `ROL` | | -| `RON` | | -| `RSD` | | -| `RUB` | | -| `RWF` | | -| `SAR` | | -| `SBD` | | -| `SCR` | | -| `SDG` | | -| `SEK` | | -| `SGD` | | -| `SHP` | | -| `SKK` | | -| `SLL` | | -| `SOS` | | -| `SRD` | | -| `STD` | | -| `SVC` | | -| `SYP` | | -| `SZL` | | -| `THB` | | -| `TJS` | | -| `TMM` | | -| `TND` | | -| `TOP` | | -| `TRL` | | -| `TRY` | | -| `TTD` | | -| `TWD` | | -| `TZS` | | -| `UAH` | | -| `UGX` | | -| `USD` | | -| `UYU` | | -| `UZS` | | -| `VEB` | | -| `VEF` | | -| `VND` | | -| `VUV` | | -| `WST` | | -| `XCD` | | -| `XOF` | | -| `XPF` | | -| `YER` | | -| `ZAR` | | -| `ZMK` | | -| `ZWD` | | -| `NONE` | | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Possible Types + +| PhysicalProductInterface Types | +|----------------| +| [`BundleProduct`](#bundleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`SimpleProduct`](#simpleproduct) | #### Example ```json -""AED"" +{"weight": 123.45} ``` -### ProductViewImage +### PickupLocation -Contains details about a product image. +Defines Pickup Location information. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The display label of the product image. For example, `Main Image`, `Small Image` or `Thumbnail Image` | -| `roles` - [`[String]`](#string) | A list that describes how the image is used. Can be `image`, `small_image` or `thumbnail` | -| `url` - [`String!`](#string) | The URL to the product image. For example, `https://example.com/image.jpg`. | +| `city` - [`String`](#string) | | +| `contact_name` - [`String`](#string) | | +| `country_id` - [`String`](#string) | | +| `description` - [`String`](#string) | | +| `email` - [`String`](#string) | | +| `fax` - [`String`](#string) | | +| `latitude` - [`Float`](#float) | | +| `longitude` - [`Float`](#float) | | +| `name` - [`String`](#string) | | +| `phone` - [`String`](#string) | | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | | +| `region` - [`String`](#string) | | +| `region_id` - [`Int`](#int) | | +| `street` - [`String`](#string) | | #### Example ```json { - "label": "xyz789", - "roles": ["xyz789"], - "url": "abc123" + "city": "abc123", + "contact_name": "abc123", + "country_id": "xyz789", + "description": "xyz789", + "email": "xyz789", + "fax": "xyz789", + "latitude": 123.45, + "longitude": 123.45, + "name": "abc123", + "phone": "abc123", + "pickup_location_code": "xyz789", + "postcode": "abc123", + "region": "xyz789", + "region_id": 123, + "street": "xyz789" } ``` -### ProductViewInputOption +### PickupLocationFilterInput -Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product. +PickupLocationFilterInput defines the list of attributes and filters for the search. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `required` - [`Boolean`](#boolean) | Indicates whether this input option is required. | -| `type` - [`String`](#string) | The type of data entry. For example, `text`, `number` or `date` | -| `markupAmount` - [`Float`](#float) | The percentage the prices is marked up or down. A positive value, such as `10.00`, indicates the product is marked up 10%. A negative value, such as `-10.00`, indicates the price is marked down 10%. | -| `suffix` - [`String`](#string) | SKU suffix to add to the product. For example, `-red`, `-blue` or `-green` | -| `sortOrder` - [`Int`](#int) | Sort order for the input option. For example, `1` for the first input option, `2` for the second input option. | -| `range` - [`ProductViewInputOptionRange`](#productviewinputoptionrange) | The range of values for the input option. For example, if the input option is a text field, the range represents the number of characters. | -| `imageSize` - [`ProductViewInputOptionImageSize`](#productviewinputoptionimagesize) | The size of the image for the input option. | -| `fileExtensions` - [`String`](#string) | The file extensions allowed for the image. For example, `jpg`, `png`, `gif`, or `svg` | +| Input Field | Description | +|-------------|-------------| +| `city` - [`FilterTypeInput`](#filtertypeinput) | Filter by city. | +| `country_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by country. | +| `name` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location name. | +| `pickup_location_code` - [`FilterTypeInput`](#filtertypeinput) | Filter by pickup location code. | +| `postcode` - [`FilterTypeInput`](#filtertypeinput) | Filter by postcode. | +| `region` - [`FilterTypeInput`](#filtertypeinput) | Filter by region. | +| `region_id` - [`FilterTypeInput`](#filtertypeinput) | Filter by region id. | +| `street` - [`FilterTypeInput`](#filtertypeinput) | Filter by street. | #### Example ```json { - "id": 4, - "title": "abc123", - "required": true, - "type": "xyz789", - "markupAmount": 987.65, - "suffix": "xyz789", - "sortOrder": 123, - "range": ProductViewInputOptionRange, - "imageSize": ProductViewInputOptionImageSize, - "fileExtensions": "xyz789" + "city": FilterTypeInput, + "country_id": FilterTypeInput, + "name": FilterTypeInput, + "pickup_location_code": FilterTypeInput, + "postcode": FilterTypeInput, + "region": FilterTypeInput, + "region_id": FilterTypeInput, + "street": FilterTypeInput } ``` -### ProductViewInputOptionImageSize - -Dimensions of the image associated with the input option. - -#### Fields +### PickupLocationSortInput -| Field Name | Description | -|------------|-------------| -| `width` - [`Int`](#int) | The width of the image in pixels. For example, `100` for a 100px width. | -| `height` - [`Int`](#int) | The height of the image, in pixels. For example, `100` for a 100px height. | +PickupLocationSortInput specifies attribute to use for sorting search results and indicates whether the results are sorted in ascending or descending order. -#### Example +#### Input Fields -```json -{"width": 123, "height": 123} +| Input Field | Description | +|-------------|-------------| +| `city` - [`SortEnum`](#sortenum) | City where pickup location is placed. | +| `contact_name` - [`SortEnum`](#sortenum) | Name of the contact person. | +| `country_id` - [`SortEnum`](#sortenum) | Id of the country in two letters. | +| `description` - [`SortEnum`](#sortenum) | Description of the pickup location. | +| `distance` - [`SortEnum`](#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`](#sortenum) | Contact email of the pickup location. | +| `fax` - [`SortEnum`](#sortenum) | Contact fax of the pickup location. | +| `latitude` - [`SortEnum`](#sortenum) | Geographic latitude where pickup location is placed. | +| `longitude` - [`SortEnum`](#sortenum) | Geographic longitude where pickup location is placed. | +| `name` - [`SortEnum`](#sortenum) | The pickup location name. Customer use this to identify the pickup location. | +| `phone` - [`SortEnum`](#sortenum) | Contact phone number of the pickup location. | +| `pickup_location_code` - [`SortEnum`](#sortenum) | A code assigned to pickup location to identify the source. | +| `postcode` - [`SortEnum`](#sortenum) | Postcode where pickup location is placed. | +| `region` - [`SortEnum`](#sortenum) | Name of the region. | +| `region_id` - [`SortEnum`](#sortenum) | Id of the region. | +| `street` - [`SortEnum`](#sortenum) | Street where pickup location is placed. | + +#### Example + +```json +{ + "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" +} ``` -### ProductViewInputOptionRange +### PickupLocations -Lists the value range associated with a `ProductViewInputOption`. For example, if the input option is a text field, the range represents the number of characters. +Top level object returned in a pickup locations search. #### Fields | Field Name | Description | |------------|-------------| -| `from` - [`Float`](#float) | The starting value of the range. For example, if the input option is a text field, the starting value represents the minimum number of characters. | -| `to` - [`Float`](#float) | The ending value of the range. For example, if the input option is a text field, the ending value represents the maximum number of characters. | +| `items` - [`[PickupLocation]`](#pickuplocation) | An array of pickup locations that match the specific search request. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | An object that includes the page_info and currentPage values specified in the query. | +| `total_count` - [`Int`](#int) | The number of products returned. | #### Example ```json -{"from": 123.45, "to": 123.45} +{ + "items": [PickupLocation], + "page_info": SearchResultPageInfo, + "total_count": 987 +} ``` -### ProductViewLink +### PlaceNegotiableQuoteOrderInput -The product link type. Contains details about product links for related products and cross selling. For example, `related`, `up_sell` or `cross_sell` +Specifies the negotiable quote to convert to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `product` - [`ProductView!`](#productview) | Contains the details of the product found in the link. | -| `linkTypes` - [`[String!]!`](#string) | Stores the types of the links with this product. | +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | #### Example ```json -{ - "product": ProductView, - "linkTypes": ["abc123"] -} +{"quote_uid": 4} ``` -### ProductViewMoney +### PlaceNegotiableQuoteOrderOutput -Defines a monetary value, including a numeric value and a currency code. +An output object that returns the generated order. #### Fields | Field Name | Description | |------------|-------------| -| `currency` - [`ProductViewCurrency`](#productviewcurrency) | A three-letter currency code, such as USD or EUR. | -| `value` - [`Float`](#float) | A number expressing a monetary value. | +| `order` - [`Order!`](#order) | Contains the generated order number. | #### Example ```json -{"currency": "AED", "value": 123.45} +{"order": Order} ``` -### ProductViewOption +### PlaceNegotiableQuoteOrderOutputV2 -Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product. +An output object that returns the generated order. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The ID of the option. For example, `123` for the first option, `456` for the second option. | -| `multi` - [`Boolean`](#boolean) | Indicates whether the option allows multiple choices. The value is `true` for a multi-select option, `false` for a single-select option. | -| `required` - [`Boolean`](#boolean) | Indicates whether the option must be selected. | -| `title` - [`String`](#string) | The display name of the option. For example, `Color`, `Size` or `Material` | -| `values` - [`[ProductViewOptionValue!]`](#productviewoptionvalue) | List of available option values. For example, `Red`, `Blue` or `Green` | +| `errors` - [`[PlaceOrderError]`](#placeordererror) | An array of place negotiable quote order errors. | +| `order` - [`CustomerOrder`](#customerorder) | Full order information. | #### Example ```json { - "id": 4, - "multi": true, - "required": false, - "title": "xyz789", - "values": [ProductViewOptionValue] + "errors": [PlaceOrderError], + "order": CustomerOrder } ``` -### ProductViewOptionValue +### PlaceOrderError -Defines the product fields available to the ProductViewOptionValueProduct and ProductViewOptionValueConfiguration types. +An error encountered while placing an order. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The ID of an option value. | -| `title` - [`String`](#string) | The display name of the option value. | -| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the out-of-stock threshold. | - -#### Possible Types - -| ProductViewOptionValue Types | -|----------------| -| [`ProductViewOptionValueConfiguration`](#productviewoptionvalueconfiguration) | -| [`ProductViewOptionValueProduct`](#productviewoptionvalueproduct) | -| [`ProductViewOptionValueSwatch`](#productviewoptionvalueswatch) | +| `code` - [`PlaceOrderErrorCodes!`](#placeordererrorcodes) | An error code that is specific to place order. | +| `message` - [`String!`](#string) | A localized error message. | #### Example ```json { - "id": "4", - "title": "abc123", - "inStock": false + "code": "CART_NOT_FOUND", + "message": "xyz789" } ``` -### ProductViewOptionValueConfiguration - -An implementation of ProductViewOptionValue for configuration values. +### PlaceOrderErrorCodes -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| `CART_NOT_FOUND` | | +| `CART_NOT_ACTIVE` | | +| `GUEST_EMAIL_MISSING` | | +| `UNABLE_TO_PLACE_ORDER` | | +| `UNDEFINED` | | #### Example ```json -{ - "id": 4, - "title": "xyz789", - "inStock": false -} +""CART_NOT_FOUND"" ``` -### ProductViewOptionValueProduct +### PlaceOrderForPurchaseOrderInput -An implementation of ProductViewOptionValue that adds details about a simple product. +Specifies the purchase order to convert to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `isDefault` - [`Boolean`](#boolean) | Indicates whether the option value is the default. | -| `product` - [`SimpleProductView`](#simpleproductview) | Details about a simple product. For example, a product with a SKU of `123`, a name of `Product 1`, a price of `100.00`. | -| `quantity` - [`Float`](#float) | Default quantity of an option value. | -| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uid` - [`ID!`](#id) | The unique ID of a purchase order. | #### Example ```json -{ - "id": 4, - "isDefault": true, - "product": SimpleProductView, - "quantity": 987.65, - "title": "xyz789", - "inStock": false -} +{"purchase_order_uid": "4"} ``` -### ProductViewOptionValueSwatch +### PlaceOrderForPurchaseOrderOutput -An implementation of ProductViewOptionValueSwatch for swatches. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | -| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | -| `type` - [`SwatchType`](#swatchtype) | Indicates the type of the swatch. | -| `value` - [`String`](#string) | The value of the swatch depending on the type of the swatch. | -| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | +| `order` - [`CustomerOrder!`](#customerorder) | Placed order. | #### Example ```json -{ - "id": 4, - "title": "abc123", - "type": "TEXT", - "value": "abc123", - "inStock": false -} +{"order": CustomerOrder} ``` -### ProductViewPrice +### PlaceOrderInput -Base product price view. Contains the final price after discounts, the regular price, and the list of tier prices. +Specifies the quote to be converted to an order. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `final` - [`Price`](#price) | Price value after discounts, excluding personalized promotions. | -| `regular` - [`Price`](#price) | Base product price specified by the merchant. | -| `tiers` - [`[ProductViewTierPrice]`](#productviewtierprice) | Volume based pricing. | -| `roles` - [`[String]`](#string) | Price roles, stating if the price should be visible or hidden. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -{ - "final": Price, - "regular": Price, - "tiers": [ProductViewTierPrice], - "roles": ["xyz789"] -} +{"cart_id": "abc123"} ``` -### ProductViewPriceRange +### PlaceOrderOutput -The minimum and maximum price of a complex product. +Contains the results of the request to place an order. #### Fields | Field Name | Description | |------------|-------------| -| `maximum` - [`ProductViewPrice`](#productviewprice) | Maximum price. | -| `minimum` - [`ProductViewPrice`](#productviewprice) | Minimum price. | +| `errors` - [`[PlaceOrderError]!`](#placeordererror) | An array of place order errors. | +| `orderV2` - [`CustomerOrder`](#customerorder) | Full order information. | #### Example ```json { - "maximum": ProductViewPrice, - "minimum": ProductViewPrice + "errors": [PlaceOrderError], + "orderV2": CustomerOrder } ``` -### ProductViewTierCondition +### PlacePurchaseOrderInput -#### Types +Specifies the quote to be converted to a purchase order. -| Union Types | -|-------------| -| [`ProductViewTierRangeCondition`](#productviewtierrangecondition) | -| [`ProductViewTierExactMatchCondition`](#productviewtierexactmatchcondition) | +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | #### Example ```json -ProductViewTierRangeCondition +{"cart_id": "xyz789"} ``` -### ProductViewTierExactMatchCondition +### PlacePurchaseOrderOutput -Minimum quantity (inclusive) required to activate this tier price. For example, a value of `10` means this tier applies when 10 or more items are purchased. +Contains the results of the request to place a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `in` - [`[Float]`](#float) | Exact quantity values that activate this tier price. For example, `[5, 10]` means the tier applies only when the purchased quantity is exactly 5 or exactly 10. | +| `purchase_order` - [`PurchaseOrder!`](#purchaseorder) | Placed purchase order. | #### Example ```json -{"in": [123.45]} +{"purchase_order": PurchaseOrder} ``` -### ProductViewTierPrice +### Price -The discounted price that applies when the quantity conditions in `quantity` are satisfied. Contains the monetary amount and any price adjustments applied to this tier. +Defines the price of a simple product or a part of a price range for a complex product. It can include a list of price adjustments. #### Fields | Field Name | Description | |------------|-------------| -| `tier` - [`Price`](#price) | The discounted price that applies when the quantity conditions in `quantity` are satisfied. Contains the monetary amount and any price adjustments applied to this tier. | -| `quantity` - [`[ProductViewTierCondition!]!`](#productviewtiercondition) | The quantity conditions that must be met to activate the tier price. For example, `10` for a quantity of 10 or `20` for a quantity of 20. | +| `adjustments` - [`[PriceAdjustment]`](#priceadjustment) | The signed value of the price adjustment (positive for markup, negative for markdown). | +| `amount` - [`ProductViewMoney`](#productviewmoney) | Contains the monetary value and currency code of a product. | #### Example ```json { - "tier": Price, - "quantity": [ProductViewTierRangeCondition] + "adjustments": [PriceAdjustment], + "amount": ProductViewMoney } ``` -### ProductViewTierRangeCondition +### PriceAdjustment -Minimum quantity (inclusive) required to activate this tier price. For example, a value of `10` means this tier applies when 10 or more items are purchased. Maximum quantity (exclusive) required to activate this tier price. For example, a value of `20` means this tier applies when less than 20 items are purchased. +Specifies the amount and type of price adjustment. #### Fields | Field Name | Description | |------------|-------------| -| `gte` - [`Float`](#float) | The minimum quantity that must be purchased to activate the tier price. Must be greater than or equal to the value in `gte`. | -| `lt` - [`Float`](#float) | Maximum quantity (exclusive) for this tier price. For example, a value of `20` means this tier applies only when fewer than 20 items are purchased. | +| `amount` - [`Float`](#float) | The amount of the price adjustment. | +| `code` - [`String`](#string) | Identifies the type of price adjustment. | #### Example ```json -{"gte": 987.65, "lt": 123.45} +{"amount": 123.45, "code": "abc123"} ``` -### ProductViewVariant +### PriceDetails -Represents a product variant. +Can be used to retrieve the main price details in case of bundle product #### Fields | Field Name | Description | |------------|-------------| -| `selections` - [`[String!]`](#string) | List of option values that make up the variant. For example, `red`, `blue` or `green` | -| `product` - [`ProductView`](#productview) | Product corresponding to the variant. For example, a product with a SKU of `123`, a name of `Product 1`, a price of `100.00`. | +| `discount_percentage` - [`Float`](#float) | The percentage of discount applied to the main product price | +| `main_final_price` - [`Float`](#float) | The final price after applying the discount to the main product | +| `main_price` - [`Float`](#float) | The regular price of the main product | #### Example ```json { - "selections": ["xyz789"], - "product": ProductView + "discount_percentage": 987.65, + "main_final_price": 987.65, + "main_price": 987.65 } ``` -### ProductViewVariantResults +### PriceRange -Represents the results of a product variant search. +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 Name | Description | |------------|-------------| -| `variants` - [`[ProductViewVariant]!`](#productviewvariant) | List of product variants. For example, a variant with a selection of `red`, `blue` or `green` | -| `cursor` - [`String`](#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | +| `maximum_price` - [`ProductPrice`](#productprice) | The highest possible price for the product. | +| `minimum_price` - [`ProductPrice!`](#productprice) | The lowest possible price for the product. | #### Example ```json { - "variants": [ProductViewVariant], - "cursor": "abc123" + "maximum_price": ProductPrice, + "minimum_price": ProductPrice } ``` -### ProductViewVideo +### PriceTypeEnum -Contains details about a product video. For example, a video of the product being used or a video of the product being assembled. +Defines the price type. -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `preview` - [`ProductViewImage`](#productviewimage) | Preview image for the video. For example, a screenshot of the video. | -| `url` - [`String!`](#string) | The URL to the product video. For example, `https://example.com/video.mp4` or `https://example.com/video.webm` | -| `description` - [`String`](#string) | Description of the product video. For example, `A video of the product being used` or `A video of the product being assembled` | -| `title` - [`String`](#string) | The title of the product video. For example, `Product Video` or `Product Assembly Video` | +| `FIXED` | | +| `PERCENT` | | +| `DYNAMIC` | | #### Example ```json -{ - "preview": ProductViewImage, - "url": "xyz789", - "description": "xyz789", - "title": "xyz789" -} +""FIXED"" ``` -### PurchaseHistory +### PriceViewEnum -User purchase history +Defines whether a bundle product's price is displayed as the lowest possible value or as a range. -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `date` - [`DateTime`](#datetime) | | -| `items` - [`[String]!`](#string) | | +| Enum Value | Description | +|------------|-------------| +| `PRICE_RANGE` | | +| `AS_LOW_AS` | | #### Example ```json -{ - "date": "2007-12-03T10:15:30Z", - "items": ["xyz789"] -} +""PRICE_RANGE"" ``` -### PurchaseOrder - -Contains details about a purchase order. +### ProductAlertPriceInput -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | -| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | -| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | -| `created_at` - [`String!`](#string) | The date the purchase order was created. | -| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | -| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | -| `number` - [`String!`](#string) | The purchase order number. | -| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | -| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | -| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | -| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | -| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | +| Input Field | Description | +|-------------|-------------| +| `sku` - [`String!`](#string) | | #### Example ```json -{ - "approval_flow": [PurchaseOrderRuleApprovalFlow], - "available_actions": ["REJECT"], - "comments": [PurchaseOrderComment], - "created_at": "abc123", - "created_by": Customer, - "history_log": [PurchaseOrderHistoryItem], - "number": "abc123", - "order": CustomerOrder, - "quote": Cart, - "status": "PENDING", - "uid": 4, - "updated_at": "abc123" -} +{"sku": "xyz789"} ``` -### PurchaseOrderAction +### ProductAlertStockInput -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `REJECT` | | -| `CANCEL` | | -| `VALIDATE` | | -| `APPROVE` | | -| `PLACE_ORDER` | | +| Input Field | Description | +|-------------|-------------| +| `sku` - [`String!`](#string) | | #### Example ```json -""REJECT"" +{"sku": "abc123"} ``` -### PurchaseOrderActionError - -Contains details about a failed action. +### ProductAlertSubscriptionResult #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The returned error message. | -| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | +| `message` - [`String`](#string) | | +| `success` - [`Boolean!`](#boolean) | | #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "success": false} ``` -### PurchaseOrderApprovalFlowEvent +### ProductAttribute -Contains details about a single event in the approval flow of the purchase order. +Contains a product attribute code and value. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String`](#string) | A formatted message. | -| `name` - [`String`](#string) | The approver name. | -| `role` - [`String`](#string) | The approver role. | -| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | -| `updated_at` - [`String`](#string) | The date and time the event was updated. | +| `code` - [`String!`](#string) | The unique identifier for a product attribute code. | +| `value` - [`String!`](#string) | The display value of the attribute. | #### Example ```json { - "message": "xyz789", - "name": "abc123", - "role": "xyz789", - "status": "PENDING", - "updated_at": "abc123" + "code": "abc123", + "value": "xyz789" } ``` -### PurchaseOrderApprovalFlowItemStatus +### ProductAttributeFile -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `PENDING` | | -| `APPROVED` | | -| `REJECTED` | | +| `attribute_type` - [`String`](#string) | Attribute type code. | +| `code` - [`ID!`](#id) | The attribute code. | +| `url` - [`String!`](#string) | Public URL to download the file. | +| `value` - [`String!`](#string) | Stored filename only (e.g. file_xyz.pdf). Use url for download. | #### Example ```json -""PENDING"" +{ + "attribute_type": "xyz789", + "code": 4, + "url": "xyz789", + "value": "abc123" +} ``` -### PurchaseOrderApprovalRule +### ProductCustomAttributes -Contains details about a purchase order approval rule. +Product custom attributes #### Fields | Field Name | Description | |------------|-------------| -| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | -| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | -| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | -| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | -| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | -| `description` - [`String`](#string) | Description of the purchase order approval rule. | -| `name` - [`String!`](#string) | The name of the purchase order approval rule. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | -| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | -| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | +| `errors` - [`[AttributeMetadataError]!`](#attributemetadataerror) | Errors when retrieving custom attributes metadata. | +| `items` - [`[AttributeValueInterface]!`](#attributevalueinterface) | Requested custom attributes | #### Example ```json { - "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" + "errors": [AttributeMetadataError], + "items": [AttributeValueInterface] } ``` -### PurchaseOrderApprovalRuleConditionAmount +### ProductDiscount -Contains approval rule condition details, including the amount to be evaluated. +Contains the discount applied to a product price. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `amount_off` - [`Float`](#float) | The actual value of the discount. | +| `percent_off` - [`Float`](#float) | The discount expressed a percentage. | #### Example ```json -{ - "amount": Money, - "attribute": "GRAND_TOTAL", - "operator": "MORE_THAN" -} +{"amount_off": 987.65, "percent_off": 987.65} ``` -### PurchaseOrderApprovalRuleConditionInterface +### ProductImage -Purchase order rule condition details. +Contains product image information, including the image URL and label. #### Fields | Field Name | Description | |------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | - -#### Possible Types - -| PurchaseOrderApprovalRuleConditionInterface Types | -|----------------| -| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | -| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} +{ + "disabled": false, + "label": "xyz789", + "position": 123, + "url": "abc123" +} ``` -### PurchaseOrderApprovalRuleConditionOperator +### ProductImageThumbnail #### Values | Enum Value | Description | |------------|-------------| -| `MORE_THAN` | | -| `LESS_THAN` | | -| `MORE_THAN_OR_EQUAL_TO` | | -| `LESS_THAN_OR_EQUAL_TO` | | +| `ITSELF` | Use thumbnail of product as image. | +| `PARENT` | Use thumbnail of product's parent as image. | #### Example ```json -""MORE_THAN"" +""ITSELF"" ``` -### PurchaseOrderApprovalRuleConditionQuantity +### ProductInfoInput -Contains approval rule condition details, including the quantity to be evaluated. +Product Information used for Pickup Locations search. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | -| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | -| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | +| Input Field | Description | +|-------------|-------------| +| `sku` - [`String!`](#string) | Product SKU. | #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"sku": "abc123"} ``` -### PurchaseOrderApprovalRuleInput +### ProductInterface -Defines a new purchase order approval rule. +Contains fields that are common to all types of products. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | -| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | -| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | -| `name` - [`String!`](#string) | The purchase order approval rule name. | -| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| Field Name | Description | +|------------|-------------| +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | + +#### Possible Types + +| ProductInterface Types | +|----------------| +| [`BundleProduct`](#bundleproduct) | +| [`ConfigurableProduct`](#configurableproduct) | +| [`DownloadableProduct`](#downloadableproduct) | +| [`GiftCardProduct`](#giftcardproduct) | +| [`GroupedProduct`](#groupedproduct) | +| [`SimpleProduct`](#simpleproduct) | +| [`VirtualProduct`](#virtualproduct) | #### Example ```json { - "applies_to": ["4"], - "approvers": [4], - "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "country_of_manufacture": "abc123", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": false, + "gift_wrapping_available": true, + "gift_wrapping_price": Money, + "image": ProductImage, + "is_returnable": "xyz789", + "manufacturer": 987, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "abc123", + "min_sale_qty": 123.45, "name": "xyz789", - "status": "ENABLED" + "new_from_date": "xyz789", + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, + "options_container": "abc123", + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 123.45, + "related_products": [ProductInterface], + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_price": 987.65, + "special_to_date": "abc123", + "stock_status": "IN_STOCK", + "swatch_image": "abc123", + "thumbnail": ProductImage, + "uid": 4, + "upsell_products": [ProductInterface], + "url_key": "xyz789" } ``` -### PurchaseOrderApprovalRuleMetadata +### ProductLinks -Contains metadata that can be used to render rule edit forms. +An implementation of `ProductLinksInterface`. #### Fields | Field Name | Description | |------------|-------------| -| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | -| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | #### Example ```json { - "available_applies_to": [CompanyRole], - "available_condition_currencies": [AvailableCurrency], - "available_requires_approval_from": [CompanyRole] + "link_type": "xyz789", + "linked_product_sku": "abc123", + "linked_product_type": "xyz789", + "position": 987, + "sku": "xyz789" } ``` -### PurchaseOrderApprovalRuleStatus +### ProductLinksInterface -#### Values +Contains information about linked products, including the link type and product type of each item. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `ENABLED` | | -| `DISABLED` | | +| `link_type` - [`String`](#string) | One of related, associated, upsell, or crosssell. | +| `linked_product_sku` - [`String`](#string) | The SKU of the linked product. | +| `linked_product_type` - [`String`](#string) | The type of linked product (simple, virtual, bundle, downloadable, grouped, configurable). | +| `position` - [`Int`](#int) | The position within the list of product links. | +| `sku` - [`String`](#string) | The identifier of the linked product. | + +#### Possible Types + +| ProductLinksInterface Types | +|----------------| +| [`ProductLinks`](#productlinks) | #### Example ```json -""ENABLED"" +{ + "link_type": "abc123", + "linked_product_sku": "xyz789", + "linked_product_type": "xyz789", + "position": 987, + "sku": "abc123" +} ``` -### PurchaseOrderApprovalRuleType +### ProductMediaGalleryEntriesAssetImage -#### Values +Contains basic information about the image asset. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `GRAND_TOTAL` | | -| `SHIPPING_INCL_TAX` | | -| `NUMBER_OF_SKUS` | | +| `asset_id` - [`String`](#string) | Asset Id. | +| `media_type` - [`String`](#string) | Must be asset-image. | +| `media_url` - [`String`](#string) | Asset Image Url. | #### Example ```json -""GRAND_TOTAL"" +{ + "asset_id": "abc123", + "media_type": "xyz789", + "media_url": "xyz789" +} ``` -### PurchaseOrderApprovalRules +### ProductMediaGalleryEntriesAssetVideo -Contains the approval rules that the customer can see. +Contains basic information about the video asset. #### Fields | Field Name | Description | |------------|-------------| -| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | -| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | +| `media_type` - [`String`](#string) | Must be asset-video. | +| `video_asset_id` - [`String`](#string) | Asset Id. | +| `video_media_url` - [`String`](#string) | Asset Video Url. | #### Example ```json { - "items": [PurchaseOrderApprovalRule], - "page_info": SearchResultPageInfo, - "total_count": 123 + "media_type": "xyz789", + "video_asset_id": "abc123", + "video_media_url": "abc123" } ``` -### PurchaseOrderComment +### ProductMediaGalleryEntriesVideoContent -Contains details about a comment. +Contains a link to a video file and basic information about the video. #### Fields | Field Name | Description | |------------|-------------| -| `author` - [`Customer`](#customer) | The user who left the comment. | -| `created_at` - [`String!`](#string) | The date and time when the comment was created. | -| `text` - [`String!`](#string) | The text of the comment. | -| `uid` - [`ID!`](#id) | A unique identifier of the comment. | +| `media_type` - [`String`](#string) | Must be external-video. | +| `video_description` - [`String`](#string) | A description of the video. | +| `video_metadata` - [`String`](#string) | Optional data about the video. | +| `video_provider` - [`String`](#string) | Describes the video source. | +| `video_title` - [`String`](#string) | The title of the video. | +| `video_url` - [`String`](#string) | The URL to the video. | #### Example ```json { - "author": Customer, - "created_at": "abc123", - "text": "abc123", - "uid": "4" + "media_type": "abc123", + "video_description": "abc123", + "video_metadata": "xyz789", + "video_provider": "abc123", + "video_title": "abc123", + "video_url": "abc123" } ``` -### PurchaseOrderErrorType +### ProductPrice -#### Values +Represents a product price. -| Enum Value | Description | +#### Fields + +| Field Name | Description | |------------|-------------| -| `NOT_FOUND` | | -| `OPERATION_NOT_APPLICABLE` | | -| `COULD_NOT_SAVE` | | -| `NOT_VALID_DATA` | | -| `UNDEFINED` | | +| `discount` - [`ProductDiscount`](#productdiscount) | The price discount. Represents the difference between the regular and final price. | +| `final_price` - [`Money!`](#money) | The final price of the product after applying discounts. | +| `fixed_product_taxes` - [`[FixedProductTax]`](#fixedproducttax) | An array of the multiple Fixed Product Taxes that can be applied to a product price. | +| `regular_price` - [`Money!`](#money) | The regular price of the product. | #### Example ```json -""NOT_FOUND"" +{ + "discount": ProductDiscount, + "final_price": Money, + "fixed_product_taxes": [FixedProductTax], + "regular_price": Money +} ``` -### PurchaseOrderHistoryItem +### ProductSearchItem -Contains details about a status change. +A single product returned by the query #### Fields | Field Name | Description | |------------|-------------| -| `activity` - [`String!`](#string) | The activity type of the event. | -| `created_at` - [`String!`](#string) | The date and time when the event happened. | -| `message` - [`String!`](#string) | The message representation of the event. | -| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | +| `applied_query_rule` - [`AppliedQueryRule`](#appliedqueryrule) | The query rule type that was applied to this product, if any (in preview mode only, returns null otherwise) | +| `highlights` - [`[Highlight]`](#highlight) | An object that provides highlighted text for matched words | +| `productView` - [`ProductView`](#productview) | Contains a product view | #### Example ```json { - "activity": "xyz789", - "created_at": "abc123", - "message": "abc123", - "uid": 4 + "applied_query_rule": AppliedQueryRule, + "highlights": [Highlight], + "productView": ProductView } ``` -### PurchaseOrderRuleApprovalFlow +### ProductSearchResponse -Contains details about approval roles applied to the purchase order and status changes. +Contains the output of a `productSearch` query #### Fields | Field Name | Description | |------------|-------------| -| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | -| `rule_name` - [`String!`](#string) | The name of the applied rule. | - -#### Example - -```json -{ - "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "abc123" -} -``` - - - -### PurchaseOrderStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `APPROVAL_REQUIRED` | | -| `APPROVED` | | -| `ORDER_IN_PROGRESS` | | -| `ORDER_PLACED` | | -| `ORDER_FAILED` | | -| `REJECTED` | | -| `CANCELED` | | -| `APPROVED_PENDING_PAYMENT` | | - -#### Example - -```json -""PENDING"" -``` - - - -### PurchaseOrders - -Contains a list of purchase orders. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | -| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | +| `facets` - [`[Aggregation]`](#aggregation) | Details about the static and dynamic facets relevant to the search | +| `items` - [`[ProductSearchItem]`](#productsearchitem) | An array of products returned by the query | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Information for rendering pages of search results | +| `related_terms` - [`[String]`](#string) | An array of strings that might include merchant-defined synonyms | +| `suggestions` - [`[String]`](#string) | An array of strings that include the names of products and categories that exist in the catalog that are similar to the search query | +| `total_count` - [`Int`](#int) | The total number of products returned that matched the query | +| `warnings` - [`[ProductSearchWarning]`](#productsearchwarning) | An array of warning messages for validation issues (e.g., sort parameter ignored due to missing categoryPath) | #### Example ```json { - "items": [PurchaseOrder], + "facets": [Aggregation], + "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "total_count": 987 + "related_terms": ["abc123"], + "suggestions": ["abc123"], + "total_count": 987, + "warnings": [ProductSearchWarning] } ``` -### PurchaseOrdersActionInput +### ProductSearchSortInput -Defines which purchase orders to act on. +The product attribute to sort on #### Input Fields | Input Field | Description | |-------------|-------------| -| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | +| `attribute` - [`String!`](#string) | The attribute code of a product attribute | +| `direction` - [`SortEnum!`](#sortenum) | ASC (ascending) or DESC (descending) | #### Example ```json -{"purchase_order_uids": [4]} +{"attribute": "abc123", "direction": "ASC"} ``` -### PurchaseOrdersActionOutput +### ProductSearchWarning -Returns a list of updated purchase orders and any error messages. +Structured warning with code and message for easier client handling #### Fields | Field Name | Description | |------------|-------------| -| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | -| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | - -#### Example - -```json -{ - "errors": [PurchaseOrderActionError], - "purchase_orders": [PurchaseOrder] -} -``` - - - -### PurchaseOrdersFilterInput - -Defines the criteria to use to filter the list of purchase orders. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | -| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | -| `my_approvals` - [`Boolean`](#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`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | -| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | - -#### Example - -```json -{ - "company_purchase_orders": false, - "created_date": FilterRangeTypeInput, - "my_approvals": true, - "require_my_approval": true, - "status": "PENDING" -} -``` - - - -### QueryContextInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `customerGroup` - [`String!`](#string) | The customer group code. Field reserved for future use. Currently, passing this field will have no impact on search results, that is, the search results will be for "Not logged in" customer | -| `userViewHistory` - [`[ViewHistoryInput!]`](#viewhistoryinput) | User view history with timestamp | +| `code` - [`String!`](#string) | Error code for programmatic handling (e.g., EMPTY_CATEGORY_PATH) | +| `message` - [`String!`](#string) | Human-readable message describing the warning | #### Example ```json { - "customerGroup": "abc123", - "userViewHistory": [ViewHistoryInput] + "code": "xyz789", + "message": "xyz789" } ``` -### QuoteItemsSortInput - -Specifies the field to use for sorting quote items - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | -| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | - -#### Example - -```json -{"field": "ITEM_ID", "order": "ASC"} -``` - - - -### QuoteTemplateExpirationDateInput +### ProductStockStatus -Sets quote template expiration date. +This enumeration states whether a product stock status is in stock or out of stock -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| Enum Value | Description | +|------------|-------------| +| `IN_STOCK` | | +| `OUT_OF_STOCK` | | #### Example ```json -{ - "expiration_date": "xyz789", - "template_id": 4 -} +""IN_STOCK"" ``` -### QuoteTemplateLineItemNoteInput +### ProductVideo -Sets quote item note. +Contains information about a product video. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `item_id` - [`ID`](#id) | The unique ID of a `CartLineItem` object. | -| `item_uid` - [`ID`](#id) | The unique ID of a `CartLineItem` object. | -| `note` - [`String`](#string) | The note text to be added. | -| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| Field Name | Description | +|------------|-------------| +| `disabled` - [`Boolean`](#boolean) | Indicates whether the image is hidden from view. | +| `label` - [`String`](#string) | The label of the product image or video. | +| `position` - [`Int`](#int) | The media item's position after it has been sorted. | +| `url` - [`String`](#string) | The URL of the product image or video. | +| `video_content` - [`ProductMediaGalleryEntriesVideoContent`](#productmediagalleryentriesvideocontent) | Contains a `ProductMediaGalleryEntriesVideoContent` object. | #### Example ```json { - "item_id": 4, - "item_uid": 4, - "note": "xyz789", - "templateId": "4" + "disabled": false, + "label": "xyz789", + "position": 987, + "url": "xyz789", + "video_content": ProductMediaGalleryEntriesVideoContent } ``` -### QuoteTemplateNotificationMessage +### ProductView -Contains a notification message for a negotiable quote template. +Defines the product fields available to the SimpleProductView and ComplexProductView types. #### Fields | Field Name | Description | |------------|-------------| -| `message` - [`String!`](#string) | The notification message. | -| `type` - [`String!`](#string) | The type of notification message. | +| `addToCartAllowed` - [`Boolean`](#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the Only X Left threshold. *(Deprecated: This field is deprecated and will be removed.)* | +| `attributes` - [`[ProductViewAttribute]`](#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by roles and names. | +| `description` - [`String`](#string) | The detailed description of the product. | +| `id` - [`ID!`](#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. | +| `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | +| `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | +| `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | Product title for search results listings. | +| `shortDescription` - [`String`](#string) | A summary of the product for search results listings. | +| `inputOptions` - [`[ProductViewInputOption]`](#productviewinputoption) | A list of input options. For example, a text field, a number field or a date field. *(Deprecated: This field is deprecated and will be removed.)* | +| `sku` - [`String`](#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](#string) | External Id *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](#string) | The URL key of the product. This is a unique identifier for the product that is used to create the product's URL. | +| `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. For example, related, up-sell, and cross-sell links. | +| `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](#string) | Visibility setting of the product | + +#### Possible Types + +| ProductView Types | +|----------------| +| [`ComplexProductView`](#complexproductview) | +| [`SimpleProductView`](#simpleproductview) | #### Example ```json { - "message": "xyz789", - "type": "xyz789" + "addToCartAllowed": false, + "inStock": true, + "lowStock": false, + "attributes": [ProductViewAttribute], + "description": "abc123", + "id": "4", + "images": [ProductViewImage], + "videos": [ProductViewVideo], + "lastModifiedAt": "2007-12-03T10:15:30Z", + "metaDescription": "abc123", + "metaKeyword": "xyz789", + "metaTitle": "xyz789", + "name": "xyz789", + "shortDescription": "xyz789", + "inputOptions": [ProductViewInputOption], + "sku": "abc123", + "externalId": "abc123", + "url": "xyz789", + "urlKey": "abc123", + "links": [ProductViewLink], + "queryType": "abc123", + "visibility": "abc123" } ``` -### RangeBucket +### ProductViewAttribute -For use on numeric product fields +A container for customer-defined attributes that are displayed the storefront. #### Fields | Field Name | Description | |------------|-------------| -| `count` - [`Int!`](#int) | The number of items in the bucket | -| `from` - [`Float!`](#float) | The minimum amount in a price range | -| `title` - [`String!`](#string) | The display text defining the price range | -| `to` - [`Float`](#float) | The maximum amount in a price range | +| `label` - [`String`](#string) | Label of the attribute. | +| `name` - [`String!`](#string) | Name of an attribute code. For example, `color`, `size` or `material` | +| `roles` - [`[String]`](#string) | Roles designated for an attribute on the storefront. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | +| `value` - [`JSON`](#json) | Attribute value, arbitrary of type. For example, `red`, `blue` or `green` | #### Example ```json { - "count": 987, - "from": 123.45, - "title": "xyz789", - "to": 123.45 + "label": "xyz789", + "name": "abc123", + "roles": ["abc123"], + "value": {} } ``` -### RangeOperatorInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `type` - [`RangeType`](#rangetype) | | -| `value` - [`RangeValueInput`](#rangevalueinput) | | - -#### Example - -```json -{"type": "UNKNOWN_RANGE_TYPE", "value": RangeValueInput} -``` - - +### ProductViewCurrency -### RangeType +The list of supported currency codes. #### Values | Enum Value | Description | |------------|-------------| -| `UNKNOWN_RANGE_TYPE` | | -| `STATIC` | | -| `PERCENTAGE` | | -| `DYNAMIC` | | - -#### Example - -```json -""UNKNOWN_RANGE_TYPE"" -``` - - - -### RangeValueInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`Float`](#float) | | -| `to` - [`Float`](#float) | | - -#### Example - -```json -{"from": 123.45, "to": 987.65} -``` - - - -### ReCaptchaConfigOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | - -#### Example - -```json -{ - "configurations": ReCaptchaConfiguration, - "is_enabled": true -} -``` - - - -### ReCaptchaConfiguration - -Contains reCAPTCHA form configuration details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `badge_position` - [`String`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `re_captcha_type` - [`ReCaptchaTypeEmum!`](#recaptchatypeemum) | | -| `technical_failure_message` - [`String!`](#string) | The message that appears when reCaptcha fails. | -| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | -| `validation_failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | - -#### Example - -```json -{ - "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": "abc123" -} -``` - - - -### ReCaptchaConfigurationV3 - -Contains reCAPTCHA V3-Invisible configuration details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | -| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | -| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | -| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | -| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | -| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | -| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | -| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | - -#### Example - -```json -{ - "badge_position": "xyz789", - "failure_message": "abc123", - "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 987.65, - "theme": "xyz789", - "website_key": "abc123" -} -``` - - - -### ReCaptchaFormConfigItem - -Contains reCAPTCHA configuration for a specific form type. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type. | -| `form_type` - [`ReCaptchaFormEnum!`](#recaptchaformenum) | The form type identifier. | -| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha is enabled for this form type. | - -#### Example - -```json -{ - "configurations": ReCaptchaConfiguration, - "form_type": "PLACE_ORDER", - "is_enabled": false -} -``` - - - -### ReCaptchaFormEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PLACE_ORDER` | | -| `CONTACT` | | -| `CUSTOMER_LOGIN` | | -| `CUSTOMER_FORGOT_PASSWORD` | | -| `CUSTOMER_CREATE` | | -| `CUSTOMER_EDIT` | | -| `NEWSLETTER` | | -| `PRODUCT_REVIEW` | | -| `SENDFRIEND` | | -| `BRAINTREE` | | -| `RESEND_CONFIRMATION_EMAIL` | | - -#### Example - -```json -""PLACE_ORDER"" -``` - - - -### ReCaptchaTypeEmum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INVISIBLE` | | -| `RECAPTCHA` | | -| `RECAPTCHA_V3` | | -| `RECAPTCHA_ENTERPRISE` | | - -#### Example - -```json -""INVISIBLE"" -``` - - - -### RecommendationUnit - -Recommendation Unit containing product and other details - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `displayOrder` - [`Int`](#int) | Order in which recommendation units are displayed | -| `pageType` - [`String`](#string) | Page type | -| `productsView` - [`[ProductView]`](#productview) | List of product view | -| `storefrontLabel` - [`String`](#string) | Storefront label to be displayed on the storefront | -| `totalProducts` - [`Int`](#int) | Total products returned in recommedations | -| `typeId` - [`String`](#string) | Type of recommendation | -| `unitId` - [`String`](#string) | Id of the preconfigured unit | -| `unitName` - [`String`](#string) | Name of the preconfigured unit | -| `userError` - [`String`](#string) | User error message if the unit could not be fully resolved (e.g. required currentSku was not provided) | - -#### Example - -```json -{ - "displayOrder": 987, - "pageType": "xyz789", - "productsView": [ProductView], - "storefrontLabel": "xyz789", - "totalProducts": 987, - "typeId": "xyz789", - "unitId": "abc123", - "unitName": "xyz789", - "userError": "xyz789" -} -``` - - - -### Recommendations - -Recommendations response - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `results` - [`[RecommendationUnit]`](#recommendationunit) | List of rec units with products recommended | -| `totalResults` - [`Int`](#int) | total number of rec units for which recommendations are returned | - -#### Example - -```json -{"results": [RecommendationUnit], "totalResults": 123} -``` - - - -### Region - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | -| `id` - [`Int`](#int) | The unique ID for a `Region` object. | -| `name` - [`String`](#string) | The name of the region, such as Texas. | - -#### Example - -```json -{ - "code": "abc123", - "id": 123, - "name": "xyz789" -} -``` - - - -### RemoveCouponFromCartInput - -Specifies the cart from which to remove a coupon. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{"cart_id": "xyz789"} -``` - - - -### RemoveCouponFromCartOutput - -Contains details about the cart after removing a coupon. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveCouponsFromCartInput - -Remove coupons from the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `coupon_codes` - [`[String]!`](#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 - -```json -{ - "cart_id": "xyz789", - "coupon_codes": ["xyz789"] -} -``` - - - -### RemoveGiftCardFromCartInput - -Defines the input required to run the `removeGiftCardFromCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | -| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | - -#### Example - -```json -{ - "cart_id": "abc123", - "gift_card_code": "abc123" -} -``` - - - -### RemoveGiftCardFromCartOutput - -Defines the possible output for the `removeGiftCardFromCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveGiftRegistryItemsOutput - -Contains the results of a request to remove an item from a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### RemoveGiftRegistryOutput - -Contains the results of a request to delete a gift registry. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | - -#### Example - -```json -{"success": true} -``` - - - -### RemoveGiftRegistryRegistrantsOutput - -Contains the results of a request to delete a registrant. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | - -#### Example - -```json -{"gift_registry": GiftRegistry} -``` - - - -### RemoveItemFromCartInput - -Specifies which items to remove from the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | - -#### Example - -```json -{ - "cart_id": "abc123", - "cart_item_uid": "4" -} -``` - - - -### RemoveItemFromCartOutput - -Contains details about the cart after removing an item. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after removing an item. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveNegotiableQuoteItemsInput - -Defines the items to remove from the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"quote_item_uids": [4], "quote_uid": 4} -``` - - - -### RemoveNegotiableQuoteItemsOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### RemoveNegotiableQuoteTemplateItemsInput - -Defines the items to remove from the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{"item_uids": [4], "template_id": 4} -``` - - - -### RemoveProductsFromCompareListInput - -Defines which products to remove from a compare list. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | -| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | - -#### Example - -```json -{ - "products": ["4"], - "uid": "4" -} -``` - - - -### RemoveProductsFromWishlistOutput - -Contains the customer's wish list and any errors encountered. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | -| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | - -#### Example - -```json -{ - "user_errors": [WishListUserInputError], - "wishlist": Wishlist -} -``` - - - -### RemoveReturnTrackingInput - -Defines the tracking information to delete. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | - -#### Example - -```json -{"return_shipping_tracking_uid": 4} -``` - - - -### RemoveReturnTrackingOutput - -Contains the response after deleting tracking information. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `return` - [`Return`](#return) | Contains details about the modified return. | - -#### Example - -```json -{"return": Return} -``` - - - -### RemoveRewardPointsFromCartOutput - -Contains the customer cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RemoveStoreCreditFromCartInput - -Defines the input required to run the `removeStoreCreditFromCart` mutation. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | - -#### Example - -```json -{"cart_id": "abc123"} -``` - - - -### RemoveStoreCreditFromCartOutput - -Defines the possible output for the `removeStoreCreditFromCart` mutation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### RenameNegotiableQuoteInput - -Sets new name for a negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | -| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | -| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | - -#### Example - -```json -{ - "quote_comment": "xyz789", - "quote_name": "abc123", - "quote_uid": 4 -} -``` - - - -### RenameNegotiableQuoteOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### ReorderItemsOutput - -Contains the cart and any errors after adding products. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | -| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | - -#### Example - -```json -{ - "cart": Cart, - "userInputErrors": [CheckoutUserInputError] -} -``` - - - -### RequestGuestReturnInput - -Contains information needed to start a return request. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `token` - [`String!`](#string) | Order token. | - -#### Example - -```json -{ - "comment_text": "xyz789", - "contact_email": "xyz789", - "items": [RequestReturnItemInput], - "token": "abc123" -} -``` - - - -### RequestNegotiableQuoteInput - -Defines properties of a negotiable quote request. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | -| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | -| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | -| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | - -#### Example - -```json -{ - "cart_id": "4", - "comment": NegotiableQuoteCommentInput, - "is_draft": true, - "quote_name": "abc123" -} -``` - - - -### RequestNegotiableQuoteOutput - -Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### RequestNegotiableQuoteTemplateInput - -Defines properties of a negotiable quote template request. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | - -#### Example - -```json -{"cart_id": "4"} -``` - - - -### RequestReturnInput - -Contains information needed to start a return request. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | -| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | -| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | -| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | - -#### Example - -```json -{ - "comment_text": "xyz789", - "contact_email": "abc123", - "items": [RequestReturnItemInput], - "order_uid": 4 -} -``` - - - -### RequestReturnItemInput - -Contains details about an item to be returned. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | -| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | -| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | -| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 - -```json -{ - "entered_custom_attributes": [ - EnteredCustomAttributeInput - ], - "order_item_uid": 4, - "quantity_to_return": 987.65, - "selected_custom_attributes": [ - SelectedCustomAttributeInput - ] -} -``` - - - -### RequestReturnOutput - -Contains the response to a return request. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `return` - [`Return`](#return) | Details about a single return request. | -| `returns` - [`Returns`](#returns) | An array of return requests. | - -#### Example - -```json -{ - "return": Return, - "returns": Returns -} -``` - - - -### RequisitionList - -Defines the contents of a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `description` - [`String`](#string) | Optional text that describes the requisition list. | -| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | -| `items_count` - [`Int!`](#int) | The number of items in the list. | -| `name` - [`String!`](#string) | The requisition list name. | -| `uid` - [`ID!`](#id) | The unique requisition list ID. | -| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | - -#### Example - -```json -{ - "description": "xyz789", - "items": RequistionListItems, - "items_count": 123, - "name": "xyz789", - "uid": "4", - "updated_at": "abc123" -} -``` - - - -### RequisitionListFilterInput - -Defines requisition list filters. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | -| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | - -#### Example - -```json -{ - "name": FilterMatchTypeInput, - "uids": FilterEqualTypeInput -} -``` - - - -### RequisitionListItemInterface - -The interface for requisition list items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The amount added. | -| `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | - -#### Possible Types - -| RequisitionListItemInterface Types | -|----------------| -| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | -| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | -| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | -| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | -| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | -| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | - -#### Example - -```json -{ - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "sku": "xyz789", - "uid": "4" -} -``` - - - -### RequisitionListItemsInput - -Defines the items to add. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | -| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | -| `quantity` - [`Float`](#float) | The quantity of the product to add. | -| `selected_options` - [`[String]`](#string) | Selected option IDs. | -| `sku` - [`String!`](#string) | The product SKU. | - -#### Example - -```json -{ - "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["xyz789"], - "sku": "abc123" -} -``` - - - -### RequisitionListSortInput - -Defines the field to use to sort a list of requisition lists. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `sort_direction` - [`SortEnum`](#sortenum) | Whether to return results in ascending or descending order. | -| `sort_field` - [`RequisitionListSortableField!`](#requisitionlistsortablefield) | The specified sort field. | - -#### Example - -```json -{"sort_direction": "ASC", "sort_field": "NAME"} -``` - - - -### RequisitionListSortableField - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NAME` | Sorts requisition lists by requisition list name. | -| `UPDATED_AT` | Sorts requisition lists by the date they were last updated. | - -#### Example - -```json -""NAME"" -``` - - - -### RequisitionLists - -Defines customer requisition lists. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | -| `total_count` - [`Int`](#int) | The number of returned requisition lists. | - -#### Example - -```json -{ - "items": [RequisitionList], - "page_info": SearchResultPageInfo, - "sort_fields": SortFields, - "total_count": 987 -} -``` - - - -### RequistionListItems - -Contains an array of items added to a requisition list. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_pages` - [`Int!`](#int) | The number of pages returned. | - -#### Example - -```json -{ - "items": [RequisitionListItemInterface], - "page_info": SearchResultPageInfo, - "total_pages": 987 -} -``` - - - -### Return - -Contains details about a return. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | -| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | -| `created_at` - [`String!`](#string) | The date the return was requested. | -| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | -| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | -| `number` - [`String!`](#string) | A human-readable return number. | -| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | -| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | -| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | -| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | - -#### Example - -```json -{ - "available_shipping_carriers": [ReturnShippingCarrier], - "comments": [ReturnComment], - "created_at": "abc123", - "customer": ReturnCustomer, - "items": [ReturnItem], - "number": "abc123", - "order": CustomerOrder, - "shipping": ReturnShipping, - "status": "PENDING", - "uid": 4 -} -``` - - - -### ReturnComment - -Contains details about a return comment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `author_name` - [`String!`](#string) | The name or author who posted the comment. | -| `created_at` - [`String!`](#string) | The date and time the comment was posted. | -| `text` - [`String!`](#string) | The contents of the comment. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | - -#### Example - -```json -{ - "author_name": "xyz789", - "created_at": "xyz789", - "text": "xyz789", - "uid": 4 -} -``` - - - -### ReturnCustomer - -The customer information for the return. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `email` - [`String!`](#string) | The email address of the customer. | -| `firstname` - [`String`](#string) | The first name of the customer. | -| `lastname` - [`String`](#string) | The last name of the customer. | - -#### Example - -```json -{ - "email": "abc123", - "firstname": "abc123", - "lastname": "abc123" -} -``` - - - -### ReturnItem - -Contains details about a product being returned. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | -| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | -| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | -| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | -| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | - -#### Example - -```json -{ - "custom_attributesV2": [AttributeValueInterface], - "order_item": OrderItemInterface, - "quantity": 123.45, - "request_quantity": 123.45, - "status": "PENDING", - "uid": "4" -} -``` - - - -### ReturnItemAttributeMetadata - -Return Item attribute metadata. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | -| `default_value` - [`String`](#string) | Default attribute value. | -| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | -| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | -| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | -| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | -| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | -| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | -| `label` - [`String`](#string) | The label assigned to the attribute. | -| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | -| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | -| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | -| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | - -#### Example - -```json -{ - "code": "4", - "default_value": "abc123", - "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", - "frontend_input": "BOOLEAN", - "input_filter": "NONE", - "is_required": false, - "is_unique": true, - "label": "xyz789", - "multiline_count": 987, - "options": [CustomAttributeOptionInterface], - "sort_order": 123, - "validate_rules": [ValidationRule] -} -``` - - - -### ReturnItemStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `AUTHORIZED` | | -| `RECEIVED` | | -| `APPROVED` | | -| `REJECTED` | | -| `DENIED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### ReturnShipping - -Contains details about the return shipping address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | -| `tracking` - [`[ReturnShippingTracking]`](#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. | - -#### Example - -```json -{ - "address": ReturnShippingAddress, - "tracking": [ReturnShippingTracking] -} -``` - - - -### ReturnShippingAddress - -Contains details about the shipping address used for receiving returned items. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `city` - [`String!`](#string) | The city for product returns. | -| `contact_name` - [`String`](#string) | The merchant's contact person. | -| `country` - [`Country!`](#country) | An object that defines the country for product returns. | -| `postcode` - [`String!`](#string) | The postal code for product returns. | -| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | -| `street` - [`[String]!`](#string) | The street address for product returns. | -| `telephone` - [`String`](#string) | The telephone number for product returns. | - -#### Example - -```json -{ - "city": "xyz789", - "contact_name": "abc123", - "country": Country, - "postcode": "abc123", - "region": Region, - "street": ["xyz789"], - "telephone": "abc123" -} -``` - - - -### ReturnShippingCarrier - -Contains details about the carrier on a return. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | A description of the shipping carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | - -#### Example - -```json -{"label": "xyz789", "uid": 4} -``` - - - -### ReturnShippingTracking - -Contains shipping and tracking details. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | -| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | -| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | -| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | - -#### Example - -```json -{ - "carrier": ReturnShippingCarrier, - "status": ReturnShippingTrackingStatus, - "tracking_number": "abc123", - "uid": 4 -} -``` - - - -### ReturnShippingTrackingStatus - -Contains the status of a shipment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `text` - [`String!`](#string) | Text that describes the status. | -| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | - -#### Example - -```json -{"text": "abc123", "type": "INFORMATION"} -``` - - - -### ReturnShippingTrackingStatusType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `INFORMATION` | | -| `ERROR` | | - -#### Example - -```json -""INFORMATION"" -``` - - - -### ReturnStatus - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `PENDING` | | -| `UNCONFIRMED` | | -| `AUTHORIZED` | | -| `PARTIALLY_AUTHORIZED` | | -| `RECEIVED` | | -| `PARTIALLY_RECEIVED` | | -| `APPROVED` | | -| `PARTIALLY_APPROVED` | | -| `REJECTED` | | -| `PARTIALLY_REJECTED` | | -| `DENIED` | | -| `PROCESSED_AND_CLOSED` | | -| `CLOSED` | | - -#### Example - -```json -""PENDING"" -``` - - - -### Returns - -Contains a list of customer return requests. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[Return]`](#return) | A list of return requests. | -| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | -| `total_count` - [`Int`](#int) | The total number of return requests. | - -#### Example - -```json -{ - "items": [Return], - "page_info": SearchResultPageInfo, - "total_count": 123 -} -``` - - - -### RevokeCustomerTokenOutput - -Contains the result of a request to revoke a customer token. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | - -#### Example - -```json -{"result": false} -``` - - - -### RewardPoints - -Contains details about a customer's reward points. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | -| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | -| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | - -#### Example - -```json -{ - "balance": RewardPointsAmount, - "balance_history": [RewardPointsBalanceHistoryItem], - "exchange_rates": RewardPointsExchangeRates, - "subscription_status": RewardPointsSubscriptionStatus -} -``` - - - -### RewardPointsAmount - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `money` - [`Money!`](#money) | The reward points amount in store currency. | -| `points` - [`Float!`](#float) | The reward points amount in points. | - -#### Example - -```json -{"money": Money, "points": 123.45} -``` - - - -### RewardPointsBalanceHistoryItem - -Contain details about the reward points transaction. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | -| `change_reason` - [`String!`](#string) | The reason the balance changed. | -| `date` - [`String!`](#string) | The date of the transaction. | -| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | - -#### Example - -```json -{ - "balance": RewardPointsAmount, - "change_reason": "xyz789", - "date": "xyz789", - "points_change": 987.65 -} -``` - - - -### RewardPointsExchangeRates - -Lists the reward points exchange rates. The values depend on the customer group. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | -| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | - -#### Example - -```json -{ - "earning": RewardPointsRate, - "redemption": RewardPointsRate -} -``` - - - -### RewardPointsRate - -Contains details about customer's reward points rate. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currency_amount` - [`Float!`](#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!`](#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 - -```json -{"currency_amount": 987.65, "points": 987.65} -``` - - - -### RewardPointsSubscriptionStatus - -Indicates whether the customer subscribes to reward points emails. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | -| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | - -#### Example - -```json -{ - "balance_updates": "SUBSCRIBED", - "points_expiration_notifications": "SUBSCRIBED" -} -``` - - - -### RewardPointsSubscriptionStatusesEnum - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `SUBSCRIBED` | | -| `NOT_SUBSCRIBED` | | - -#### Example - -```json -""SUBSCRIBED"" -``` - - - -### SDKParams - -Defines the name and value of a SDK parameter - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String`](#string) | The name of the SDK parameter | -| `value` - [`String`](#string) | The value of the SDK parameter | - -#### Example - -```json -{ - "name": "xyz789", - "value": "xyz789" -} -``` - - - -### SalesCommentItem - -Contains details about a comment. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `message` - [`String!`](#string) | The text of the message. | -| `timestamp` - [`String!`](#string) | The timestamp of the comment. | - -#### Example - -```json -{ - "message": "xyz789", - "timestamp": "xyz789" -} -``` - - - -### ScalarBucket - -For use on string and other scalar product fields - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `count` - [`Int!`](#int) | The number of items in the bucket | -| `id` - [`ID!`](#id) | An identifier that can be used for filtering. It may contain non-human readable data | -| `title` - [`String!`](#string) | The display text for the scalar value | - -#### Example - -```json -{"count": 987, "id": 4, "title": "xyz789"} -``` - - - -### ScopeTypeEnum - -This enumeration defines the scope type for customer orders. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `GLOBAL` | | -| `WEBSITE` | | -| `STORE` | | - -#### Example - -```json -""GLOBAL"" -``` - - - -### SearchClauseInput - -A product attribute to filter on - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute` - [`String!`](#string) | The attribute code of a product attribute | -| `contains` - [`String`](#string) | attribute value should contain the specified string | -| `eq` - [`String`](#string) | A string value to filter on | -| `in` - [`[String]`](#string) | An array of string values to filter on | -| `range` - [`SearchRangeInput`](#searchrangeinput) | A range of numeric values to filter on | -| `startsWith` - [`String`](#string) | attribute value should start with the specified string | - -#### Example - -```json -{ - "attribute": "xyz789", - "contains": "abc123", - "eq": "xyz789", - "in": ["xyz789"], - "range": SearchRangeInput, - "startsWith": "xyz789" -} -``` - - - -### SearchRangeInput - -A range of numeric values for use in a search - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `from` - [`Float`](#float) | The minimum value to filter on. If not specified, the value of `0` is applied | -| `to` - [`Float`](#float) | The maximum value to filter on | - -#### Example - -```json -{"from": 987.65, "to": 123.45} -``` - - - -### SearchResultPageInfo - -Provides navigation for the query response. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `current_page` - [`Int`](#int) | The specific page to return. | -| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | -| `total_pages` - [`Int`](#int) | The total number of pages in the response. | - -#### Example - -```json -{"current_page": 987, "page_size": 123, "total_pages": 987} -``` - - - -### SelectedBundleOption - -Contains details about a selected bundle option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The display name of the selected bundle product option. | -| `type` - [`String!`](#string) | The type of selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | -| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | - -#### Example - -```json -{ - "label": "xyz789", - "type": "xyz789", - "uid": "4", - "values": [SelectedBundleOptionValue] -} -``` - - - -### SelectedBundleOptionValue - -Contains details about a value for a selected bundle option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | -| `original_price` - [`Money!`](#money) | The original price of the value for the selected bundle product option. | -| `priceV2` - [`Money!`](#money) | The price of the value for the selected bundle product option. | -| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | -| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | - -#### Example - -```json -{ - "label": "abc123", - "original_price": Money, - "priceV2": Money, - "quantity": 987.65, - "uid": 4 -} -``` - - - -### SelectedConfigurableOption - -Contains details about a selected configurable option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | -| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | -| `option_label` - [`String!`](#string) | The display text for the option. | -| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | - -#### Example - -```json -{ - "configurable_product_option_uid": "4", - "configurable_product_option_value_uid": "4", - "option_label": "xyz789", - "value_label": "abc123" -} -``` - - - -### SelectedCustomAttributeInput - -Contains details about an attribute the buyer selected. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | -| `value` - [`String!`](#string) | The unique ID for a selected custom attribute value. | - -#### Example - -```json -{ - "attribute_code": "abc123", - "value": "abc123" -} -``` - - - -### SelectedCustomizableOption - -Identifies a customized product that has been placed in a cart. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | -| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | -| `label` - [`String!`](#string) | The display name of the selected customizable option. | -| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | -| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | -| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | - -#### Example - -```json -{ - "customizable_option_uid": "4", - "is_required": false, - "label": "abc123", - "sort_order": 123, - "type": "abc123", - "values": [SelectedCustomizableOptionValue] -} -``` - - - -### SelectedCustomizableOptionValue - -Identifies the value of the selected customized option. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | -| `label` - [`String!`](#string) | The display name of the selected value. | -| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | -| `value` - [`String!`](#string) | The text identifying the selected value. | - -#### Example - -```json -{ - "customizable_option_value_uid": "4", - "label": "abc123", - "price": CartItemSelectedOptionValuePrice, - "value": "abc123" -} -``` - - - -### SelectedPaymentMethod - -Describes the payment method selected by the shopper. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `code` - [`String!`](#string) | The payment method code. | -| `oope_payment_method_config` - [`OopePaymentMethodConfig`](#oopepaymentmethodconfig) | Configuration for out of process payment methods | -| `purchase_order_number` - [`String`](#string) | The purchase order number. | -| `title` - [`String!`](#string) | The payment method title. | - -#### Example - -```json -{ - "code": "xyz789", - "oope_payment_method_config": OopePaymentMethodConfig, - "purchase_order_number": "abc123", - "title": "xyz789" -} -``` - - - -### SelectedShippingMethod - -Contains details about the selected shipping method and carrier. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `additional_data` - [`[ShippingAdditionalData]`](#shippingadditionaldata) | Additional data related to the shipping method. | -| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | -| `carrier_title` - [`String!`](#string) | The label for the carrier code. | -| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | -| `method_title` - [`String!`](#string) | The label for the method code. | -| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | -| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | - -#### Example - -```json -{ - "additional_data": [ShippingAdditionalData], - "amount": Money, - "carrier_code": "abc123", - "carrier_title": "abc123", - "method_code": "xyz789", - "method_title": "xyz789", - "price_excl_tax": Money, - "price_incl_tax": Money -} -``` - - - -### SendNegotiableQuoteForReviewInput - -Specifies which negotiable quote to send for review. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} -``` - - - -### SendNegotiableQuoteForReviewOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetBillingAddressOnCartInput - -Sets the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | - -#### Example - -```json -{ - "billing_address": BillingAddressInput, - "cart_id": "abc123" -} -``` - - - -### SetBillingAddressOnCartOutput - -Contains details about the cart after setting the billing address. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetCartAsInactiveOutput - -Sets the cart as inactive - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `error` - [`String`](#string) | The error message returned after failing to set the cart as inactive | -| `success` - [`Boolean!`](#boolean) | Indicates whether the cart was set as inactive | - -#### Example - -```json -{"error": "abc123", "success": true} -``` - - - -### SetCustomAttributesOnCompanyInput - -Defines the company custom attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for company. | -| `id` - [`ID!`](#id) | The unique ID of a `company` object. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttributeInput], - "id": "4" -} -``` - - - -### SetCustomAttributesOnCompanyOutput - -Contains the company. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `company` - [`Company`](#company) | The company after assigning custom attributes. | - -#### Example - -```json -{"company": Company} -``` - - - -### SetCustomAttributesOnNegotiableQuoteInput - -Defines the negotiable quote custom attributes. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for NegotiableQuote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "custom_attributes": [CustomAttributeInput], - "quote_uid": 4 -} -``` - - - -### SetCustomAttributesOnNegotiableQuoteOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning custom attributes. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetGiftOptionsOnCartInput - -Defines the gift options applied to the cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | -| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | -| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | -| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | -| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | - -#### Example - -```json -{ - "cart_id": "abc123", - "gift_message": GiftMessageInput, - "gift_receipt_included": false, - "gift_wrapping_id": 4, - "printed_card_included": false -} -``` - - - -### SetGiftOptionsOnCartOutput - -Contains the cart after gift options have been applied. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The modified cart object. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetGuestEmailOnCartInput - -Defines the guest email and cart. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `email` - [`String!`](#string) | The email address of the guest. | - -#### Example - -```json -{ - "cart_id": "xyz789", - "email": "xyz789" -} -``` - - - -### SetGuestEmailOnCartOutput - -Contains details about the cart after setting the email of a guest. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetLineItemNoteOutput - -Contains the updated negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuoteBillingAddressInput - -Sets the billing address. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | - -#### Example - -```json -{ - "billing_address": NegotiableQuoteBillingAddressInput, - "quote_uid": 4 -} -``` - - - -### SetNegotiableQuoteBillingAddressOutput - -Contains the negotiable quote. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | - -#### Example - -```json -{"quote": NegotiableQuote} -``` - - - -### SetNegotiableQuotePaymentMethodInput - -Defines the payment method of the specified negotiable quote. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `AED` | | +| `AFN` | | +| `ALL` | | +| `AMD` | | +| `ANG` | | +| `AOA` | | +| `ARS` | | +| `AUD` | | +| `AWG` | | +| `AZM` | | +| `AZN` | | +| `BAM` | | +| `BBD` | | +| `BDT` | | +| `BGN` | | +| `BHD` | | +| `BIF` | | +| `BMD` | | +| `BND` | | +| `BOB` | | +| `BRL` | | +| `BSD` | | +| `BTN` | | +| `BUK` | | +| `BWP` | | +| `BYN` | | +| `BZD` | | +| `CAD` | | +| `CDF` | | +| `CHE` | | +| `CHF` | | +| `CHW` | | +| `CLP` | | +| `CNY` | | +| `COP` | | +| `CRC` | | +| `CUP` | | +| `CVE` | | +| `CZK` | | +| `DJF` | | +| `DKK` | | +| `DOP` | | +| `DZD` | | +| `EEK` | | +| `EGP` | | +| `ERN` | | +| `ETB` | | +| `EUR` | | +| `FJD` | | +| `FKP` | | +| `GBP` | | +| `GEK` | | +| `GEL` | | +| `GHS` | | +| `GIP` | | +| `GMD` | | +| `GNF` | | +| `GQE` | | +| `GTQ` | | +| `GYD` | | +| `HKD` | | +| `HNL` | | +| `HRK` | | +| `HTG` | | +| `HUF` | | +| `IDR` | | +| `ILS` | | +| `INR` | | +| `IQD` | | +| `IRR` | | +| `ISK` | | +| `JMD` | | +| `JOD` | | +| `JPY` | | +| `KES` | | +| `KGS` | | +| `KHR` | | +| `KMF` | | +| `KPW` | | +| `KRW` | | +| `KWD` | | +| `KYD` | | +| `KZT` | | +| `LAK` | | +| `LBP` | | +| `LKR` | | +| `LRD` | | +| `LSL` | | +| `LSM` | | +| `LTL` | | +| `LVL` | | +| `LYD` | | +| `MAD` | | +| `MDL` | | +| `MGA` | | +| `MKD` | | +| `MMK` | | +| `MNT` | | +| `MOP` | | +| `MRO` | | +| `MUR` | | +| `MVR` | | +| `MWK` | | +| `MXN` | | +| `MYR` | | +| `MZN` | | +| `NAD` | | +| `NGN` | | +| `NIC` | | +| `NOK` | | +| `NPR` | | +| `NZD` | | +| `OMR` | | +| `PAB` | | +| `PEN` | | +| `PGK` | | +| `PHP` | | +| `PKR` | | +| `PLN` | | +| `PYG` | | +| `QAR` | | +| `RHD` | | +| `ROL` | | +| `RON` | | +| `RSD` | | +| `RUB` | | +| `RWF` | | +| `SAR` | | +| `SBD` | | +| `SCR` | | +| `SDG` | | +| `SEK` | | +| `SGD` | | +| `SHP` | | +| `SKK` | | +| `SLL` | | +| `SOS` | | +| `SRD` | | +| `STD` | | +| `SVC` | | +| `SYP` | | +| `SZL` | | +| `THB` | | +| `TJS` | | +| `TMM` | | +| `TND` | | +| `TOP` | | +| `TRL` | | +| `TRY` | | +| `TTD` | | +| `TWD` | | +| `TZS` | | +| `UAH` | | +| `UGX` | | +| `USD` | | +| `UYU` | | +| `UZS` | | +| `VEB` | | +| `VEF` | | +| `VND` | | +| `VUV` | | +| `WST` | | +| `XCD` | | +| `XOF` | | +| `XPF` | | +| `YER` | | +| `ZAR` | | +| `ZMK` | | +| `ZWD` | | +| `NONE` | | #### Example ```json -{ - "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 -} +""AED"" ``` -### SetNegotiableQuotePaymentMethodOutput +### ProductViewImage -Contains details about the negotiable quote after setting the payment method. +Contains details about a product image. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | +| `label` - [`String`](#string) | The display label of the product image. For example, `Main Image`, `Small Image` or `Thumbnail Image` | +| `roles` - [`[String]`](#string) | A list that describes how the image is used. Can be `image`, `small_image` or `thumbnail` | +| `url` - [`String!`](#string) | The URL to the product image. For example, `https://example.com/image.jpg`. | #### Example ```json -{"quote": NegotiableQuote} +{ + "label": "xyz789", + "roles": ["xyz789"], + "url": "abc123" +} ``` -### SetNegotiableQuoteShippingAddressInput +### ProductViewInputOption -Defines the shipping address to assign to the negotiable quote. +Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `required` - [`Boolean`](#boolean) | Indicates whether this input option is required. | +| `type` - [`String`](#string) | The type of data entry. For example, `text`, `number` or `date` | +| `markupAmount` - [`Float`](#float) | The percentage the prices is marked up or down. A positive value, such as `10.00`, indicates the product is marked up 10%. A negative value, such as `-10.00`, indicates the price is marked down 10%. | +| `suffix` - [`String`](#string) | SKU suffix to add to the product. For example, `-red`, `-blue` or `-green` | +| `sortOrder` - [`Int`](#int) | Sort order for the input option. For example, `1` for the first input option, `2` for the second input option. | +| `range` - [`ProductViewInputOptionRange`](#productviewinputoptionrange) | The range of values for the input option. For example, if the input option is a text field, the range represents the number of characters. | +| `imageSize` - [`ProductViewInputOptionImageSize`](#productviewinputoptionimagesize) | The size of the image for the input option. | +| `fileExtensions` - [`String`](#string) | The file extensions allowed for the image. For example, `jpg`, `png`, `gif`, or `svg` | #### Example ```json { - "quote_uid": "4", - "shipping_addresses": [ - NegotiableQuoteShippingAddressInput - ] + "id": "4", + "title": "abc123", + "required": false, + "type": "xyz789", + "markupAmount": 987.65, + "suffix": "abc123", + "sortOrder": 123, + "range": ProductViewInputOptionRange, + "imageSize": ProductViewInputOptionImageSize, + "fileExtensions": "abc123" } ``` -### SetNegotiableQuoteShippingAddressOutput +### ProductViewInputOptionImageSize -Contains the negotiable quote. +Dimensions of the image associated with the input option. #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | +| `width` - [`Int`](#int) | The width of the image in pixels. For example, `100` for a 100px width. | +| `height` - [`Int`](#int) | The height of the image, in pixels. For example, `100` for a 100px height. | #### Example ```json -{"quote": NegotiableQuote} +{"width": 123, "height": 987} ``` -### SetNegotiableQuoteShippingMethodsInput +### ProductViewInputOptionRange -Defines the shipping method to apply to the negotiable quote. +Lists the value range associated with a `ProductViewInputOption`. For example, if the input option is a text field, the range represents the number of characters. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | +| Field Name | Description | +|------------|-------------| +| `from` - [`Float`](#float) | The starting value of the range. For example, if the input option is a text field, the starting value represents the minimum number of characters. | +| `to` - [`Float`](#float) | The ending value of the range. For example, if the input option is a text field, the ending value represents the maximum number of characters. | #### Example ```json -{ - "quote_uid": 4, - "shipping_methods": [ShippingMethodInput] -} +{"from": 987.65, "to": 123.45} ``` -### SetNegotiableQuoteShippingMethodsOutput +### ProductViewLink -Contains the negotiable quote. +The product link type. Contains details about product links for related products and cross selling. For example, `related`, `up_sell` or `cross_sell` #### Fields | Field Name | Description | |------------|-------------| -| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | +| `product` - [`ProductView!`](#productview) | Contains the details of the product found in the link. | +| `linkTypes` - [`[String!]!`](#string) | Stores the types of the links with this product. | #### Example ```json -{"quote": NegotiableQuote} +{ + "product": ProductView, + "linkTypes": ["abc123"] +} ``` -### SetNegotiableQuoteTemplateShippingAddressInput +### ProductViewMoney -Defines the shipping address to assign to the negotiable quote template. +Defines a monetary value, including a numeric value and a currency code. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| Field Name | Description | +|------------|-------------| +| `currency` - [`ProductViewCurrency`](#productviewcurrency) | A three-letter currency code, such as USD or EUR. | +| `value` - [`Float`](#float) | A number expressing a monetary value. | #### Example ```json -{ - "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": "4" -} +{"currency": "AED", "value": 987.65} ``` -### SetPaymentMethodOnCartInput +### ProductViewOption -Applies a payment method to the cart. +Product options provide a way to configure products by making selections of particular option values. Selecting one or many options will point to a simple product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The ID of the option. For example, `123` for the first option, `456` for the second option. | +| `multi` - [`Boolean`](#boolean) | Indicates whether the option allows multiple choices. The value is `true` for a multi-select option, `false` for a single-select option. | +| `required` - [`Boolean`](#boolean) | Indicates whether the option must be selected. | +| `title` - [`String`](#string) | The display name of the option. For example, `Color`, `Size` or `Material` | +| `values` - [`[ProductViewOptionValue!]`](#productviewoptionvalue) | List of available option values. For example, `Red`, `Blue` or `Green` | #### Example ```json { - "cart_id": "xyz789", - "payment_method": PaymentMethodInput + "id": "4", + "multi": true, + "required": true, + "title": "abc123", + "values": [ProductViewOptionValue] } ``` -### SetPaymentMethodOnCartOutput +### ProductViewOptionValue -Contains details about the cart after setting the payment method. +Defines the product fields available to the ProductViewOptionValueProduct and ProductViewOptionValueConfiguration types. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | - -#### Example - -```json -{"cart": Cart} -``` - - - -### SetShippingAddressesOnCartInput - -Specifies an array of addresses to use for shipping. +| `id` - [`ID`](#id) | The ID of an option value. | +| `title` - [`String`](#string) | The display name of the option value. | +| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the out-of-stock threshold. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | +| ProductViewOptionValue Types | +|----------------| +| [`ProductViewOptionValueConfiguration`](#productviewoptionvalueconfiguration) | +| [`ProductViewOptionValueProduct`](#productviewoptionvalueproduct) | +| [`ProductViewOptionValueSwatch`](#productviewoptionvalueswatch) | #### Example ```json { - "cart_id": "xyz789", - "shipping_addresses": [ShippingAddressInput] + "id": "4", + "title": "xyz789", + "inStock": true } ``` -### SetShippingAddressesOnCartOutput +### ProductViewOptionValueConfiguration -Contains details about the cart after setting the shipping addresses. +An implementation of ProductViewOptionValue for configuration values. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | +| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json -{"cart": Cart} +{ + "id": "4", + "title": "abc123", + "inStock": true +} ``` -### SetShippingMethodsOnCartInput +### ProductViewOptionValueProduct -Applies one or shipping methods to the cart. +An implementation of ProductViewOptionValue that adds details about a simple product. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | -| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | +| Field Name | Description | +|------------|-------------| +| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `isDefault` - [`Boolean`](#boolean) | Indicates whether the option value is the default. | +| `product` - [`SimpleProductView`](#simpleproductview) | Details about a simple product. For example, a product with a SKU of `123`, a name of `Product 1`, a price of `100.00`. | +| `quantity` - [`Float`](#float) | Default quantity of an option value. | +| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json { - "cart_id": "abc123", - "shipping_methods": [ShippingMethodInput] + "id": "4", + "isDefault": true, + "product": SimpleProductView, + "quantity": 123.45, + "title": "abc123", + "inStock": true } ``` -### SetShippingMethodsOnCartOutput +### ProductViewOptionValueSwatch -Contains details about the cart after setting the shipping methods. +An implementation of ProductViewOptionValueSwatch for swatches. #### Fields | Field Name | Description | |------------|-------------| -| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | +| `id` - [`ID`](#id) | The ID of an option value. For example, `123` for the first option value, `456` for the second option value. | +| `title` - [`String`](#string) | The display name of the option value. For example, `Red`, `Blue` or `Green` | +| `type` - [`SwatchType`](#swatchtype) | Indicates the type of the swatch. | +| `value` - [`String`](#string) | The value of the swatch depending on the type of the swatch. | +| `inStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product option value has reached the out-of-stock threshold. | #### Example ```json -{"cart": Cart} +{ + "id": "4", + "title": "abc123", + "type": "TEXT", + "value": "abc123", + "inStock": true +} ``` -### ShareGiftRegistryInviteeInput +### ProductViewPrice -Defines a gift registry invitee. +Base product price view. Contains the final price after discounts, the regular price, and the list of tier prices. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `email` - [`String!`](#string) | The email address of the gift registry invitee. | -| `name` - [`String!`](#string) | The name of the gift registry invitee. | +| Field Name | Description | +|------------|-------------| +| `final` - [`Price`](#price) | Price value after discounts, excluding personalized promotions. | +| `regular` - [`Price`](#price) | Base product price specified by the merchant. | +| `tiers` - [`[ProductViewTierPrice]`](#productviewtierprice) | Volume based pricing. | +| `roles` - [`[String]`](#string) | Price roles, stating if the price should be visible or hidden. For example, `show_on_plp`, `show_in_pdp` or `show_in_search` | #### Example ```json { - "email": "xyz789", - "name": "xyz789" + "final": Price, + "regular": Price, + "tiers": [ProductViewTierPrice], + "roles": ["xyz789"] } ``` -### ShareGiftRegistryOutput +### ProductViewPriceRange -Contains the results of a request to share a gift registry. +The minimum and maximum price of a complex product. #### Fields | Field Name | Description | |------------|-------------| -| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | +| `maximum` - [`ProductViewPrice`](#productviewprice) | Maximum price. | +| `minimum` - [`ProductViewPrice`](#productviewprice) | Minimum price. | #### Example ```json -{"is_shared": true} +{ + "maximum": ProductViewPrice, + "minimum": ProductViewPrice +} ``` -### ShareGiftRegistrySenderInput - -Defines the sender of an invitation to view a gift registry. +### ProductViewTierCondition -#### Input Fields +#### Types -| Input Field | Description | -|-------------|-------------| -| `message` - [`String!`](#string) | A brief message from the sender. | -| `name` - [`String!`](#string) | The sender of the gift registry invitation. | +| Union Types | +|-------------| +| [`ProductViewTierRangeCondition`](#productviewtierrangecondition) | +| [`ProductViewTierExactMatchCondition`](#productviewtierexactmatchcondition) | #### Example ```json -{ - "message": "xyz789", - "name": "xyz789" -} +ProductViewTierRangeCondition ``` -### ShareRequisitionListByEmailInput +### ProductViewTierExactMatchCondition -An input object that defines which requisition list shared with company users through email. +Minimum quantity (inclusive) required to activate this tier price. For example, a value of `10` means this tier applies when 10 or more items are purchased. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `customerUids` - [`[ID]!`](#id) | An array of IDs representing company users with whom the sender wants to share the requisition list. | -| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | +| Field Name | Description | +|------------|-------------| +| `in` - [`[Float]`](#float) | Exact quantity values that activate this tier price. For example, `[5, 10]` means the tier applies only when the purchased quantity is exactly 5 or exactly 10. | #### Example ```json -{ - "customerUids": [4], - "requisitionListUid": "4" -} +{"in": [987.65]} ``` -### ShareRequisitionListByEmailOutput +### ProductViewTierPrice -Result of sharing a requisition list by email. +The discounted price that applies when the quantity conditions in `quantity` are satisfied. Contains the monetary amount and any price adjustments applied to this tier. #### Fields | Field Name | Description | |------------|-------------| -| `sent_count` - [`Int!`](#int) | Number of notification emails successfully sent. | -| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Per-email validation or delivery issues. | +| `tier` - [`Price`](#price) | The discounted price that applies when the quantity conditions in `quantity` are satisfied. Contains the monetary amount and any price adjustments applied to this tier. | +| `quantity` - [`[ProductViewTierCondition!]!`](#productviewtiercondition) | The quantity conditions that must be met to activate the tier price. For example, `10` for a quantity of 10 or `20` for a quantity of 20. | #### Example ```json { - "sent_count": 987, - "user_errors": [ShareRequisitionListUserError] + "tier": Price, + "quantity": [ProductViewTierRangeCondition] } ``` -### ShareRequisitionListByTokenOutput +### ProductViewTierRangeCondition -The result of sharing a requisition list by token. +Minimum quantity (inclusive) required to activate this tier price. For example, a value of `10` means this tier applies when 10 or more items are purchased. Maximum quantity (exclusive) required to activate this tier price. For example, a value of `20` means this tier applies when less than 20 items are purchased. #### Fields | Field Name | Description | |------------|-------------| -| `token` - [`String!`](#string) | Token used to generate a shareable link for the requisition list. | +| `gte` - [`Float`](#float) | The minimum quantity that must be purchased to activate the tier price. Must be greater than or equal to the value in `gte`. | +| `lt` - [`Float`](#float) | Maximum quantity (exclusive) for this tier price. For example, a value of `20` means this tier applies only when fewer than 20 items are purchased. | #### Example ```json -{"token": "abc123"} +{"gte": 123.45, "lt": 987.65} ``` -### ShareRequisitionListUserError +### ProductViewVariant -An error related to a specific recipient or constraint. +Represents a product variant. #### Fields | Field Name | Description | |------------|-------------| -| `code` - [`ShareRequisitionListUserErrorCode!`](#sharerequisitionlistusererrorcode) | Machine-readable error code. | -| `message` - [`String!`](#string) | Human-readable error message. | +| `selections` - [`[String!]`](#string) | List of option values that make up the variant. For example, `red`, `blue` or `green` | +| `product` - [`ProductView`](#productview) | Product corresponding to the variant. For example, a product with a SKU of `123`, a name of `Product 1`, a price of `100.00`. | #### Example ```json { - "code": "MAX_RECIPIENTS_EXCEEDED", - "message": "xyz789" + "selections": ["xyz789"], + "product": ProductView } ``` -### ShareRequisitionListUserErrorCode +### ProductViewVariantResults -Machine-readable error codes for requisition list share-by-email and import operations. +Represents the results of a product variant search. -#### Values +#### Fields -| Enum Value | Description | +| Field Name | Description | |------------|-------------| -| `MAX_RECIPIENTS_EXCEEDED` | | -| `INVALID_EMAIL` | | -| `NOT_COMPANY_USER` | | -| `IMPORT_FAILED` | | +| `variants` - [`[ProductViewVariant]!`](#productviewvariant) | List of product variants. For example, a variant with a selection of `red`, `blue` or `green` | +| `cursor` - [`String`](#string) | Pagination cursor. For example, `123` for the first variant, `456` for the second variant. | #### Example ```json -""MAX_RECIPIENTS_EXCEEDED"" +{ + "variants": [ProductViewVariant], + "cursor": "abc123" +} ``` -### SharedRequisitionListOutput +### ProductViewVideo -Shared requisition list view for a recipient. +Contains details about a product video. For example, a video of the product being used or a video of the product being assembled. #### Fields | Field Name | Description | |------------|-------------| -| `requisition_list` - [`RequisitionList!`](#requisitionlist) | The sender's requisition list (read-only for the recipient). | -| `sender_name` - [`String!`](#string) | Display name of the requisition list sender. | +| `preview` - [`ProductViewImage`](#productviewimage) | Preview image for the video. For example, a screenshot of the video. | +| `url` - [`String!`](#string) | The URL to the product video. For example, `https://example.com/video.mp4` or `https://example.com/video.webm` | +| `description` - [`String`](#string) | Description of the product video. For example, `A video of the product being used` or `A video of the product being assembled` | +| `title` - [`String`](#string) | The title of the product video. For example, `Product Video` or `Product Assembly Video` | #### Example ```json { - "requisition_list": RequisitionList, - "sender_name": "abc123" + "preview": ProductViewImage, + "url": "xyz789", + "description": "xyz789", + "title": "abc123" } ``` -### ShipBundleItemsEnum +### PurchaseHistory -Defines whether bundle items must be shipped together. +User purchase history -#### Values +#### Input Fields -| Enum Value | Description | -|------------|-------------| -| `TOGETHER` | | -| `SEPARATELY` | | +| Input Field | Description | +|-------------|-------------| +| `date` - [`DateTime`](#datetime) | | +| `items` - [`[String]!`](#string) | | #### Example ```json -""TOGETHER"" +{ + "date": "2007-12-03T10:15:30Z", + "items": ["abc123"] +} ``` -### ShipmentItem +### PurchaseOrder + +Contains details about a purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | +| `approval_flow` - [`[PurchaseOrderRuleApprovalFlow]`](#purchaseorderruleapprovalflow) | The approval flows for each applied rules. | +| `available_actions` - [`[PurchaseOrderAction]!`](#purchaseorderaction) | Purchase order actions available to the customer. Can be used to display action buttons on the client. | +| `comments` - [`[PurchaseOrderComment]!`](#purchaseordercomment) | The set of comments applied to the purchase order. | +| `created_at` - [`String!`](#string) | The date the purchase order was created. | +| `created_by` - [`Customer`](#customer) | The company user who created the purchase order. | +| `history_log` - [`[PurchaseOrderHistoryItem]!`](#purchaseorderhistoryitem) | The log of the events related to the purchase order. | +| `number` - [`String!`](#string) | The purchase order number. | +| `order` - [`CustomerOrder`](#customerorder) | The reference to the order placed based on the purchase order. | +| `quote` - [`Cart`](#cart) | The quote related to the purchase order. | +| `status` - [`PurchaseOrderStatus!`](#purchaseorderstatus) | The current status of the purchase order. | +| `uid` - [`ID!`](#id) | A unique identifier for the purchase order. | +| `updated_at` - [`String!`](#string) | The date the purchase order was last updated. | #### Example ```json { - "id": "4", - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 123.45 + "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" } ``` -### ShipmentItemInterface - -Order shipment item details. +### PurchaseOrderAction -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | -| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | -| `product_name` - [`String`](#string) | The name of the base product. | -| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | -| `product_sku` - [`String!`](#string) | The SKU of the base product. | -| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | - -#### Possible Types - -| ShipmentItemInterface Types | -|----------------| -| [`BundleShipmentItem`](#bundleshipmentitem) | -| [`GiftCardShipmentItem`](#giftcardshipmentitem) | -| [`ShipmentItem`](#shipmentitem) | +| `REJECT` | | +| `CANCEL` | | +| `VALIDATE` | | +| `APPROVE` | | +| `PLACE_ORDER` | | #### Example ```json -{ - "id": 4, - "order_item": OrderItemInterface, - "product_name": "xyz789", - "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 123.45 -} +""REJECT"" ``` -### ShipmentTracking +### PurchaseOrderActionError -Contains order shipment tracking details. +Contains details about a failed action. #### Fields | Field Name | Description | |------------|-------------| -| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | -| `number` - [`String`](#string) | The tracking number of the order shipment. | -| `title` - [`String!`](#string) | The shipment tracking title. | -| `tracking_url` - [`String`](#string) | The tracking URL for the shipment. Available for both built-in and custom shipping carriers when a URL template is configured. | +| `message` - [`String!`](#string) | The returned error message. | +| `type` - [`PurchaseOrderErrorType!`](#purchaseordererrortype) | The error type. | #### Example ```json -{ - "carrier": "xyz789", - "number": "abc123", - "title": "abc123", - "tracking_url": "abc123" -} +{"message": "abc123", "type": "NOT_FOUND"} ``` -### ShippingAdditionalData +### PurchaseOrderApprovalFlowEvent -A simple key value object. +Contains details about a single event in the approval flow of the purchase order. #### Fields | Field Name | Description | |------------|-------------| -| `key` - [`String`](#string) | | -| `value` - [`String`](#string) | | +| `message` - [`String`](#string) | A formatted message. | +| `name` - [`String`](#string) | The approver name. | +| `role` - [`String`](#string) | The approver role. | +| `status` - [`PurchaseOrderApprovalFlowItemStatus`](#purchaseorderapprovalflowitemstatus) | The status related to the event. | +| `updated_at` - [`String`](#string) | The date and time the event was updated. | #### Example ```json { - "key": "xyz789", - "value": "xyz789" + "message": "abc123", + "name": "abc123", + "role": "xyz789", + "status": "PENDING", + "updated_at": "abc123" } ``` -### ShippingAddressInput - -Defines a single shipping address. +### PurchaseOrderApprovalFlowItemStatus -#### Input Fields +#### Values -| Input Field | Description | -|-------------|-------------| -| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | -| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `APPROVED` | | +| `REJECTED` | | #### Example ```json -{ - "address": CartAddressInput, - "customer_address_id": 987, - "customer_address_uid": 4, - "customer_notes": "xyz789", - "pickup_location_code": "abc123" -} +""PENDING"" ``` -### ShippingCartAddress +### PurchaseOrderApprovalRule -Contains shipping addresses and methods. +Contains details about a purchase order approval rule. #### Fields | Field Name | Description | |------------|-------------| -| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | -| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | -| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | -| `company` - [`String`](#string) | The company specified for the billing or shipping address. | -| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | -| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | -| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | -| `customer_notes` - [`String`](#string) | Text provided by the shopper. | -| `fax` - [`String`](#string) | The customer's fax number. | -| `firstname` - [`String!`](#string) | The first name of the customer or guest. | -| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | -| `lastname` - [`String!`](#string) | The last name of the customer or guest. | -| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | -| `pickup_location_code` - [`String`](#string) | | -| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | -| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | -| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | -| `same_as_billing` - [`Boolean!`](#boolean) | Indicates whether the shipping address is same as billing address. | -| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | -| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | -| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | -| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | -| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | +| `applies_to_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user(s) affected by the the purchase order approval rule. | +| `approver_roles` - [`[CompanyRole]!`](#companyrole) | The name of the user who needs to approve purchase orders that trigger the approval rule. | +| `condition` - [`PurchaseOrderApprovalRuleConditionInterface`](#purchaseorderapprovalruleconditioninterface) | Condition which triggers the approval rule. | +| `created_at` - [`String!`](#string) | The date the purchase order rule was created. | +| `created_by` - [`String!`](#string) | The name of the user who created the purchase order approval rule. | +| `description` - [`String`](#string) | Description of the purchase order approval rule. | +| `name` - [`String!`](#string) | The name of the purchase order approval rule. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | +| `uid` - [`ID!`](#id) | The unique identifier for the purchase order approval rule. | +| `updated_at` - [`String!`](#string) | The date the purchase order rule was last updated. | #### Example ```json { - "available_shipping_methods": [AvailableShippingMethod], - "cart_items_v2": [CartItemInterface], - "city": "abc123", - "company": "xyz789", - "country": CartAddressCountry, - "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "abc123", - "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", - "pickup_location_code": "abc123", - "postcode": "xyz789", - "prefix": "abc123", - "region": CartAddressRegion, - "same_as_billing": true, - "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", + "applies_to_roles": [CompanyRole], + "approver_roles": [CompanyRole], + "condition": PurchaseOrderApprovalRuleConditionInterface, + "created_at": "abc123", + "created_by": "abc123", + "description": "abc123", + "name": "abc123", + "status": "ENABLED", "uid": 4, - "vat_id": "xyz789" + "updated_at": "xyz789" } ``` -### ShippingDiscount +### PurchaseOrderApprovalRuleConditionAmount -Defines an individual shipping discount. This discount can be applied to shipping. +Contains approval rule condition details, including the amount to be evaluated. #### Fields | Field Name | Description | |------------|-------------| -| `amount` - [`Money!`](#money) | The amount of the discount. | +| `amount` - [`Money!`](#money) | The amount to be be used for evaluation of the approval rule condition. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | #### Example ```json -{"amount": Money} +{ + "amount": Money, + "attribute": "GRAND_TOTAL", + "operator": "MORE_THAN" +} ``` -### ShippingHandling +### PurchaseOrderApprovalRuleConditionInterface -Contains details about shipping and handling costs. +Purchase order rule condition details. #### Fields | Field Name | Description | |------------|-------------| -| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | -| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | -| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | -| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | -| `total_amount` - [`Money!`](#money) | The total amount for shipping. | - -#### Example - -```json -{ - "amount_excluding_tax": Money, - "amount_including_tax": Money, - "discounts": [ShippingDiscount], - "taxes": [TaxItem], - "total_amount": Money -} -``` - - - -### ShippingMethodInput - -Defines the shipping carrier and method. +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | -#### Input Fields +#### Possible Types -| Input Field | Description | -|-------------|-------------| -| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | -| `method_code` - [`String!`](#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. | +| PurchaseOrderApprovalRuleConditionInterface Types | +|----------------| +| [`PurchaseOrderApprovalRuleConditionAmount`](#purchaseorderapprovalruleconditionamount) | +| [`PurchaseOrderApprovalRuleConditionQuantity`](#purchaseorderapprovalruleconditionquantity) | #### Example ```json -{ - "carrier_code": "abc123", - "method_code": "abc123" -} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN"} ``` -### SimpleCartItem - -An implementation for simple product cart items. +### PurchaseOrderApprovalRuleConditionOperator -#### Fields +#### Values -| Field Name | Description | +| Enum Value | Description | |------------|-------------| -| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | -| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | -| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | -| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | -| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | -| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | -| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | -| `max_qty` - [`Float`](#float) | Line item max qty in quote template | -| `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | -| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | -| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | -| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | -| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | -| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | +| `MORE_THAN` | | +| `LESS_THAN` | | +| `MORE_THAN_OR_EQUAL_TO` | | +| `LESS_THAN_OR_EQUAL_TO` | | #### Example ```json -{ - "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", - "custom_attributes": [CustomAttribute], - "customizable_options": [SelectedCustomizableOption], - "discount": [Discount], - "errors": [CartItemError], - "gift_message": GiftMessage, - "gift_wrapping": GiftWrapping, - "is_available": false, - "is_salable": true, - "max_qty": 987.65, - "min_qty": 123.45, - "not_available_message": "abc123", - "note_from_buyer": [ItemNote], - "note_from_seller": [ItemNote], - "prices": CartItemPrices, - "product": ProductInterface, - "quantity": 987.65, - "uid": 4 -} +""MORE_THAN"" ``` -### SimpleProduct +### PurchaseOrderApprovalRuleConditionQuantity -Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. +Contains approval rule condition details, including the quantity to be evaluated. #### Fields | Field Name | Description | |------------|-------------| -| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | -| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | -| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | -| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | -| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | -| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | -| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | -| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | -| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | -| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | -| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | -| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | -| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | -| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | -| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | -| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | -| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | -| `new_to_date` - [`String`](#string) | The end date for new product listings. | -| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | -| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | -| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | -| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | -| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | -| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | -| `quantity` - [`Float`](#float) | Quantity of available stock | -| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | -| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | -| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | -| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | -| `special_price` - [`Float`](#float) | The discounted price of the product. | -| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | -| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | -| `swatch_image` - [`String`](#string) | The file name of a swatch image. | -| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | -| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | -| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | -| `url_key` - [`String`](#string) | The part of the URL that identifies the product | -| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | +| `attribute` - [`PurchaseOrderApprovalRuleType`](#purchaseorderapprovalruletype) | The type of purchase order approval rule. | +| `operator` - [`PurchaseOrderApprovalRuleConditionOperator`](#purchaseorderapprovalruleconditionoperator) | The operator to be used for evaluating the approval rule condition. | +| `quantity` - [`Int`](#int) | The quantity to be used for evaluation of the approval rule condition. | #### Example ```json -{ - "canonical_url": "abc123", - "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", - "crosssell_products": [ProductInterface], - "custom_attributesV2": ProductCustomAttributes, - "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": true, - "gift_wrapping_price": Money, - "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 123, - "max_sale_qty": 123.45, - "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "xyz789", - "min_sale_qty": 987.65, - "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, - "options": [CustomizableOptionInterface], - "options_container": "xyz789", - "price_range": PriceRange, - "price_tiers": [TierPrice], - "product_links": [ProductLinksInterface], - "quantity": 123.45, - "related_products": [ProductInterface], - "short_description": ComplexTextValue, - "sku": "abc123", - "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", - "stock_status": "IN_STOCK", - "swatch_image": "xyz789", - "thumbnail": ProductImage, - "uid": 4, - "upsell_products": [ProductInterface], - "url_key": "abc123", - "weight": 987.65 -} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} ``` -### SimpleProductView +### PurchaseOrderApprovalRuleInput -Represents a single-SKU product without selectable variants. Because there are no variant combinations, pricing is returned as a single price (not a price range). +Defines a new purchase order approval rule. -#### Fields +#### Input Fields -| Field Name | Description | -|------------|-------------| -| `addToCartAllowed` - [`Boolean`](#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | -| `inStock` - [`Boolean`](#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | -| `lowStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the Only X Left threshold. *(Deprecated: This field is deprecated and will be removed.)* | -| `attributes` - [`[ProductViewAttribute]`](#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles. | -| `description` - [`String`](#string) | The detailed description of the product. | -| `id` - [`ID!`](#id) | The product ID, generated as a composite key, unique per locale. | -| `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image`, and `swatch`. | -| `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | -| `inputOptions` - [`[ProductViewInputOption]`](#productviewinputoption) | A list of input options. For example, a text field, a number field or a date field. *(Deprecated: This field is deprecated and will be removed.)* | -| `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | -| `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | -| `metaKeyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | -| `metaTitle` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | -| `name` - [`String`](#string) | Product name. | -| `price` - [`ProductViewPrice`](#productviewprice) | Base product price view. | -| `shortDescription` - [`String`](#string) | A summary of the product. | -| `sku` - [`String`](#string) | A unique code used for identification of a product. | -| `externalId` - [`String`](#string) | External Id. For example, `123`, `456` or `789`. *(Deprecated: This field is deprecated and will be removed.)* | -| `url` - [`String`](#string) | Canonical URL of the product. For example, `https://example.com/product-1` or `https://example.com/product-2`. *(Deprecated: This field is deprecated and will be removed.)* | -| `urlKey` - [`String`](#string) | The URL key of the product. For example, `product-1`, `product-2` or `product-3`. | -| `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. For example, a related product, an up-sell product or a cross-sell product. | -| `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | -| `visibility` - [`String`](#string) | Visibility setting of the product | +| Input Field | Description | +|-------------|-------------| +| `applies_to` - [`[ID]!`](#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]!`](#id) | A list of B2B user roles that can approve this purchase order approval rule. | +| `condition` - [`CreatePurchaseOrderApprovalRuleConditionInput!`](#createpurchaseorderapprovalruleconditioninput) | The condition of the purchase order approval rule. | +| `description` - [`String`](#string) | A summary of the purpose of the purchase order approval rule. | +| `name` - [`String!`](#string) | The purchase order approval rule name. | +| `status` - [`PurchaseOrderApprovalRuleStatus!`](#purchaseorderapprovalrulestatus) | The status of the purchase order approval rule. | #### Example ```json { - "addToCartAllowed": false, - "inStock": false, - "lowStock": true, - "attributes": [ProductViewAttribute], + "applies_to": ["4"], + "approvers": [4], + "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "abc123", - "id": 4, - "images": [ProductViewImage], - "videos": [ProductViewVideo], - "inputOptions": [ProductViewInputOption], - "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", - "metaTitle": "xyz789", "name": "abc123", - "price": ProductViewPrice, - "shortDescription": "xyz789", - "sku": "abc123", - "externalId": "abc123", - "url": "xyz789", - "urlKey": "abc123", - "links": [ProductViewLink], - "queryType": "xyz789", - "visibility": "abc123" + "status": "ENABLED" } ``` -### SimpleRequisitionListItem +### PurchaseOrderApprovalRuleMetadata -Contains details about simple products added to a requisition list. +Contains metadata that can be used to render rule edit forms. #### Fields | Field Name | Description | |------------|-------------| -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | -| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The amount added. | -| `sku` - [`String!`](#string) | The product SKU. | -| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | +| `available_applies_to` - [`[CompanyRole]!`](#companyrole) | A list of B2B user roles that the rule can be applied to. | +| `available_condition_currencies` - [`[AvailableCurrency]!`](#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]!`](#companyrole) | A list of B2B user roles that can be specified as approvers for the approval rules. | #### Example ```json { - "customizable_options": [SelectedCustomizableOption], - "product": ProductInterface, - "quantity": 123.45, - "sku": "abc123", - "uid": 4 + "available_applies_to": [CompanyRole], + "available_condition_currencies": [AvailableCurrency], + "available_requires_approval_from": [CompanyRole] } ``` -### SimpleWishlistItem +### PurchaseOrderApprovalRuleStatus -Contains a simple product wish list item. +#### Values -#### Fields +| Enum Value | Description | +|------------|-------------| +| `ENABLED` | | +| `DISABLED` | | -| Field Name | Description | +#### Example + +```json +""ENABLED"" +``` + + + +### PurchaseOrderApprovalRuleType + +#### Values + +| Enum Value | Description | |------------|-------------| -| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | -| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | -| `description` - [`String`](#string) | The description of the item. | -| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | -| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | -| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | +| `GRAND_TOTAL` | | +| `SHIPPING_INCL_TAX` | | +| `NUMBER_OF_SKUS` | | #### Example ```json -{ - "added_at": "abc123", - "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": 4, - "product": ProductInterface, - "quantity": 123.45 -} +""GRAND_TOTAL"" ``` -### SmartButtonMethodInput +### PurchaseOrderApprovalRules -Smart button payment inputs +Contains the approval rules that the customer can see. -#### Input Fields +#### Fields -| Input Field | Description | -|-------------|-------------| -| `payment_source` - [`String`](#string) | The payment source for the payment method | -| `payments_order_id` - [`String`](#string) | The payment services order ID | -| `paypal_order_id` - [`String`](#string) | PayPal order ID | +| Field Name | Description | +|------------|-------------| +| `items` - [`[PurchaseOrderApprovalRule]!`](#purchaseorderapprovalrule) | A list of purchase order approval rules visible to the customer. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Result pagination details. | +| `total_count` - [`Int`](#int) | The total number of purchase order approval rules visible to the customer. | #### Example ```json { - "payment_source": "abc123", - "payments_order_id": "abc123", - "paypal_order_id": "xyz789" + "items": [PurchaseOrderApprovalRule], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### SmartButtonsConfig +### PurchaseOrderComment + +Contains details about a comment. #### Fields | Field Name | Description | |------------|-------------| -| `app_switch_when_available` - [`Boolean`](#boolean) | Indicated whether to use App Switch on enabled mobile devices | -| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | -| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | -| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | -| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | -| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | -| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | -| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | -| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | -| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | -| `title` - [`String`](#string) | The name displayed for the payment method | +| `author` - [`Customer`](#customer) | The user who left the comment. | +| `created_at` - [`String!`](#string) | The date and time when the comment was created. | +| `text` - [`String!`](#string) | The text of the comment. | +| `uid` - [`ID!`](#id) | A unique identifier of the comment. | #### Example ```json { - "app_switch_when_available": false, - "button_styles": ButtonStyles, - "code": "xyz789", - "display_message": true, - "display_venmo": true, - "is_visible": false, - "message_styles": MessageStyles, - "payment_intent": "xyz789", - "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "xyz789" + "author": Customer, + "created_at": "xyz789", + "text": "abc123", + "uid": "4" } ``` -### SortEnum - -Indicates whether to return results in ascending or descending order. +### PurchaseOrderErrorType #### Values | Enum Value | Description | |------------|-------------| -| `ASC` | | -| `DESC` | | +| `NOT_FOUND` | | +| `OPERATION_NOT_APPLICABLE` | | +| `COULD_NOT_SAVE` | | +| `NOT_VALID_DATA` | | +| `UNDEFINED` | | #### Example ```json -""ASC"" +""NOT_FOUND"" ``` -### SortField +### PurchaseOrderHistoryItem -Defines a possible sort field. +Contains details about a status change. #### Fields | Field Name | Description | |------------|-------------| -| `label` - [`String`](#string) | The label of the sort field. | -| `value` - [`String`](#string) | The attribute code of the sort field. | +| `activity` - [`String!`](#string) | The activity type of the event. | +| `created_at` - [`String!`](#string) | The date and time when the event happened. | +| `message` - [`String!`](#string) | The message representation of the event. | +| `uid` - [`ID!`](#id) | A unique identifier of the purchase order history item. | #### Example ```json { - "label": "xyz789", - "value": "abc123" + "activity": "xyz789", + "created_at": "abc123", + "message": "abc123", + "uid": 4 } ``` -### SortFields +### PurchaseOrderRuleApprovalFlow -Contains a default value for sort fields and all available sort fields. +Contains details about approval roles applied to the purchase order and status changes. #### Fields | Field Name | Description | |------------|-------------| -| `default` - [`String`](#string) | The default sort field value. | -| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | +| `events` - [`[PurchaseOrderApprovalFlowEvent]!`](#purchaseorderapprovalflowevent) | The approval flow event related to the rule. | +| `rule_name` - [`String!`](#string) | The name of the applied rule. | #### Example ```json { - "default": "abc123", - "options": [SortField] + "events": [PurchaseOrderApprovalFlowEvent], + "rule_name": "abc123" } ``` -### SortQuoteItemsEnum - -Specifies the field to use for sorting quote items +### PurchaseOrderStatus #### Values | Enum Value | Description | |------------|-------------| -| `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` | | +| `PENDING` | | +| `APPROVAL_REQUIRED` | | +| `APPROVED` | | +| `ORDER_IN_PROGRESS` | | +| `ORDER_PLACED` | | +| `ORDER_FAILED` | | +| `REJECTED` | | +| `CANCELED` | | +| `APPROVED_PENDING_PAYMENT` | | #### Example ```json -""ITEM_ID"" +""PENDING"" ``` -### SortableAttribute +### PurchaseOrders -Contains product attributes that be used for sorting in a `productSearch` query +Contains a list of purchase orders. #### Fields | Field Name | Description | |------------|-------------| -| `attribute` - [`String!`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without space | -| `frontendInput` - [`String`](#string) | Indicates how field rendered on storefront | -| `label` - [`String`](#string) | The display name assigned to the attribute | -| `numeric` - [`Boolean`](#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | +| `items` - [`[PurchaseOrder]!`](#purchaseorder) | Purchase orders matching the search criteria. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Page information of search result's current page. | +| `total_count` - [`Int`](#int) | Total number of purchase orders found matching the search criteria. | #### Example ```json { - "attribute": "abc123", - "frontendInput": "abc123", - "label": "abc123", - "numeric": true + "items": [PurchaseOrder], + "page_info": SearchResultPageInfo, + "total_count": 123 } ``` -### StatsBucket +### PurchaseOrdersActionInput + +Defines which purchase orders to act on. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `purchase_order_uids` - [`[ID]!`](#id) | An array of purchase order UIDs. | + +#### Example + +```json +{"purchase_order_uids": [4]} +``` + + + +### PurchaseOrdersActionOutput -For retrieving statistics across multiple buckets +Returns a list of updated purchase orders and any error messages. #### Fields | Field Name | Description | |------------|-------------| -| `max` - [`Float!`](#float) | The maximum value | -| `min` - [`Float!`](#float) | The minimum value | -| `title` - [`String!`](#string) | The display text for the bucket | +| `errors` - [`[PurchaseOrderActionError]!`](#purchaseorderactionerror) | An array of error messages encountered while performing the operation. | +| `purchase_orders` - [`[PurchaseOrder]!`](#purchaseorder) | A list of purchase orders. | #### Example ```json { - "max": 987.65, - "min": 123.45, - "title": "abc123" + "errors": [PurchaseOrderActionError], + "purchase_orders": [PurchaseOrder] +} +``` + + + +### PurchaseOrdersFilterInput + +Defines the criteria to use to filter the list of purchase orders. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `company_purchase_orders` - [`Boolean`](#boolean) | Include only purchase orders made by subordinate company users. | +| `created_date` - [`FilterRangeTypeInput`](#filterrangetypeinput) | Filter by the creation date of the purchase order. | +| `my_approvals` - [`Boolean`](#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`](#boolean) | Include only purchase orders that are waiting for the customer’s approval. | +| `status` - [`PurchaseOrderStatus`](#purchaseorderstatus) | Filter by the status of the purchase order. | + +#### Example + +```json +{ + "company_purchase_orders": false, + "created_date": FilterRangeTypeInput, + "my_approvals": true, + "require_my_approval": true, + "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md new file mode 100644 index 000000000..51181ada2 --- /dev/null +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md @@ -0,0 +1,4269 @@ +## Types + +### QueryContextInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customerGroup` - [`String!`](#string) | The customer group code. Field reserved for future use. Currently, passing this field will have no impact on search results, that is, the search results will be for "Not logged in" customer | +| `userViewHistory` - [`[ViewHistoryInput!]`](#viewhistoryinput) | User view history with timestamp | + +#### Example + +```json +{ + "customerGroup": "xyz789", + "userViewHistory": [ViewHistoryInput] +} +``` + + + +### QuoteItemsSortInput + +Specifies the field to use for sorting quote items + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `field` - [`SortQuoteItemsEnum!`](#sortquoteitemsenum) | Specifies the quote items field to sort by | +| `order` - [`SortEnum!`](#sortenum) | Specifies the order of quote items' sorting | + +#### Example + +```json +{"field": "ITEM_ID", "order": "ASC"} +``` + + + +### QuoteTemplateExpirationDateInput + +Sets quote template expiration date. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "expiration_date": "xyz789", + "template_id": 4 +} +``` + + + +### QuoteTemplateLineItemNoteInput + +Sets quote item note. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_id` - [`ID`](#id) | The unique ID of a `CartLineItem` object. | +| `item_uid` - [`ID`](#id) | The unique ID of a `CartLineItem` object. | +| `note` - [`String`](#string) | The note text to be added. | +| `templateId` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "item_id": 4, + "item_uid": 4, + "note": "abc123", + "templateId": 4 +} +``` + + + +### QuoteTemplateNotificationMessage + +Contains a notification message for a negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The notification message. | +| `type` - [`String!`](#string) | The type of notification message. | + +#### Example + +```json +{ + "message": "abc123", + "type": "xyz789" +} +``` + + + +### RangeBucket + +For use on numeric product fields + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int!`](#int) | The number of items in the bucket | +| `from` - [`Float!`](#float) | The minimum amount in a price range | +| `title` - [`String!`](#string) | The display text defining the price range | +| `to` - [`Float`](#float) | The maximum amount in a price range | + +#### Example + +```json +{ + "count": 123, + "from": 987.65, + "title": "xyz789", + "to": 123.45 +} +``` + + + +### RangeOperatorInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `type` - [`RangeType`](#rangetype) | | +| `value` - [`RangeValueInput`](#rangevalueinput) | | + +#### Example + +```json +{"type": "UNKNOWN_RANGE_TYPE", "value": RangeValueInput} +``` + + + +### RangeType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNKNOWN_RANGE_TYPE` | | +| `STATIC` | | +| `PERCENTAGE` | | +| `DYNAMIC` | | + +#### Example + +```json +""UNKNOWN_RANGE_TYPE"" +``` + + + +### RangeValueInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`Float`](#float) | | +| `to` - [`Float`](#float) | | + +#### Example + +```json +{"from": 123.45, "to": 987.65} +``` + + + +### ReCaptchaConfigOutput + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type | +| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha type is enabled | + +#### Example + +```json +{ + "configurations": ReCaptchaConfiguration, + "is_enabled": false +} +``` + + + +### ReCaptchaConfiguration + +Contains reCAPTCHA form configuration details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `badge_position` - [`String`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `re_captcha_type` - [`ReCaptchaTypeEmum!`](#recaptchatypeemum) | | +| `technical_failure_message` - [`String!`](#string) | The message that appears when reCaptcha fails. | +| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | +| `validation_failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | + +#### Example + +```json +{ + "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" +} +``` + + + +### ReCaptchaConfigurationV3 + +Contains reCAPTCHA V3-Invisible configuration details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `badge_position` - [`String!`](#string) | The position of the invisible reCAPTCHA badge on each page. | +| `failure_message` - [`String!`](#string) | The message that appears to the user if validation fails. | +| `forms` - [`[ReCaptchaFormEnum]!`](#recaptchaformenum) | A list of forms on the storefront that have been configured to use reCAPTCHA V3. | +| `is_enabled` - [`Boolean!`](#boolean) | Return whether recaptcha is enabled or not | +| `language_code` - [`String`](#string) | A two-character code that specifies the language that is used for Google reCAPTCHA text and messaging. | +| `minimum_score` - [`Float!`](#float) | The minimum score that identifies a user interaction as a potential risk. | +| `theme` - [`String!`](#string) | Theme to be used to render reCaptcha. | +| `website_key` - [`String!`](#string) | The website key generated when the Google reCAPTCHA account was registered. | + +#### Example + +```json +{ + "badge_position": "abc123", + "failure_message": "xyz789", + "forms": ["PLACE_ORDER"], + "is_enabled": false, + "language_code": "xyz789", + "minimum_score": 987.65, + "theme": "abc123", + "website_key": "xyz789" +} +``` + + + +### ReCaptchaFormConfigItem + +Contains reCAPTCHA configuration for a specific form type. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurations` - [`ReCaptchaConfiguration`](#recaptchaconfiguration) | Configuration details for reCaptcha type. | +| `form_type` - [`ReCaptchaFormEnum!`](#recaptchaformenum) | The form type identifier. | +| `is_enabled` - [`Boolean!`](#boolean) | Indicates whether reCaptcha is enabled for this form type. | + +#### Example + +```json +{ + "configurations": ReCaptchaConfiguration, + "form_type": "PLACE_ORDER", + "is_enabled": true +} +``` + + + +### ReCaptchaFormEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PLACE_ORDER` | | +| `CONTACT` | | +| `CUSTOMER_LOGIN` | | +| `CUSTOMER_FORGOT_PASSWORD` | | +| `CUSTOMER_CREATE` | | +| `CUSTOMER_EDIT` | | +| `NEWSLETTER` | | +| `PRODUCT_REVIEW` | | +| `SENDFRIEND` | | +| `BRAINTREE` | | +| `RESEND_CONFIRMATION_EMAIL` | | + +#### Example + +```json +""PLACE_ORDER"" +``` + + + +### ReCaptchaTypeEmum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INVISIBLE` | | +| `RECAPTCHA` | | +| `RECAPTCHA_V3` | | +| `RECAPTCHA_ENTERPRISE` | | + +#### Example + +```json +""INVISIBLE"" +``` + + + +### RecommendationUnit + +Recommendation Unit containing product and other details + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `displayOrder` - [`Int`](#int) | Order in which recommendation units are displayed | +| `pageType` - [`String`](#string) | Page type | +| `productsView` - [`[ProductView]`](#productview) | List of product view | +| `storefrontLabel` - [`String`](#string) | Storefront label to be displayed on the storefront | +| `totalProducts` - [`Int`](#int) | Total products returned in recommedations | +| `typeId` - [`String`](#string) | Type of recommendation | +| `unitId` - [`String`](#string) | Id of the preconfigured unit | +| `unitName` - [`String`](#string) | Name of the preconfigured unit | +| `userError` - [`String`](#string) | User error message if the unit could not be fully resolved (e.g. required currentSku was not provided) | + +#### Example + +```json +{ + "displayOrder": 123, + "pageType": "abc123", + "productsView": [ProductView], + "storefrontLabel": "abc123", + "totalProducts": 123, + "typeId": "xyz789", + "unitId": "xyz789", + "unitName": "abc123", + "userError": "abc123" +} +``` + + + +### Recommendations + +Recommendations response + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `results` - [`[RecommendationUnit]`](#recommendationunit) | List of rec units with products recommended | +| `totalResults` - [`Int`](#int) | total number of rec units for which recommendations are returned | + +#### Example + +```json +{"results": [RecommendationUnit], "totalResults": 123} +``` + + + +### Region + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String`](#string) | The two-letter code for the region, such as TX for Texas. | +| `id` - [`Int`](#int) | The unique ID for a `Region` object. | +| `name` - [`String`](#string) | The name of the region, such as Texas. | + +#### Example + +```json +{ + "code": "abc123", + "id": 987, + "name": "xyz789" +} +``` + + + +### RemoveCouponFromCartInput + +Specifies the cart from which to remove a coupon. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### RemoveCouponFromCartOutput + +Contains details about the cart after removing a coupon. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart`](#cart) | The cart after removing a coupon. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveCouponsFromCartInput + +Remove coupons from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `coupon_codes` - [`[String]!`](#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 + +```json +{ + "cart_id": "abc123", + "coupon_codes": ["abc123"] +} +``` + + + +### RemoveGiftCardFromCartInput + +Defines the input required to run the `removeGiftCardFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | +| `gift_card_code` - [`String!`](#string) | The gift card code to be removed to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "gift_card_code": "xyz789" +} +``` + + + +### RemoveGiftCardFromCartOutput + +Defines the possible output for the `removeGiftCardFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveGiftRegistryItemsOutput + +Contains the results of a request to remove an item from a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after removing items. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveGiftRegistryOutput + +Contains the results of a request to delete a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `success` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully deleted. | + +#### Example + +```json +{"success": true} +``` + + + +### RemoveGiftRegistryRegistrantsOutput + +Contains the results of a request to delete a registrant. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `gift_registry` - [`GiftRegistry`](#giftregistry) | The gift registry after deleting registrants. | + +#### Example + +```json +{"gift_registry": GiftRegistry} +``` + + + +### RemoveItemFromCartInput + +Specifies which items to remove from the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `cart_item_uid` - [`ID`](#id) | Required field. The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{"cart_id": "abc123", "cart_item_uid": 4} +``` + + + +### RemoveItemFromCartOutput + +Contains details about the cart after removing an item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after removing an item. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveNegotiableQuoteItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{"quote_item_uids": [4], "quote_uid": 4} +``` + + + +### RemoveNegotiableQuoteItemsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after removing items. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RemoveNegotiableQuoteTemplateItemsInput + +Defines the items to remove from the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `item_uids` - [`[ID]!`](#id) | An array of IDs indicating which items to remove from the negotiable quote. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{"item_uids": [4], "template_id": 4} +``` + + + +### RemoveProductsFromCompareListInput + +Defines which products to remove from a compare list. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `products` - [`[ID]!`](#id) | An array of product IDs to remove from the compare list. | +| `uid` - [`ID!`](#id) | The unique identifier of the compare list to modify. | + +#### Example + +```json +{"products": [4], "uid": 4} +``` + + + +### RemoveProductsFromWishlistOutput + +Contains the customer's wish list and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `user_errors` - [`[WishListUserInputError]!`](#wishlistuserinputerror) | An array of errors encountered while deleting products from a wish list. | +| `wishlist` - [`Wishlist!`](#wishlist) | Contains the wish list with after items were successfully deleted. | + +#### Example + +```json +{ + "user_errors": [WishListUserInputError], + "wishlist": Wishlist +} +``` + + + +### RemoveReturnTrackingInput + +Defines the tracking information to delete. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `return_shipping_tracking_uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object. | + +#### Example + +```json +{"return_shipping_tracking_uid": 4} +``` + + + +### RemoveReturnTrackingOutput + +Contains the response after deleting tracking information. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Contains details about the modified return. | + +#### Example + +```json +{"return": Return} +``` + + + +### RemoveRewardPointsFromCartOutput + +Contains the customer cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The customer cart after reward points are removed. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RemoveStoreCreditFromCartInput + +Defines the input required to run the `removeStoreCreditFromCart` mutation. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the customer's cart. | + +#### Example + +```json +{"cart_id": "xyz789"} +``` + + + +### RemoveStoreCreditFromCartOutput + +Defines the possible output for the `removeStoreCreditFromCart` mutation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The contents of the specified shopping cart. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### RenameNegotiableQuoteInput + +Sets new name for a negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_comment` - [`String`](#string) | The reason for the quote name change specified by the buyer. | +| `quote_name` - [`String!`](#string) | The new quote name the buyer specified to the negotiable quote request. | +| `quote_uid` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | + +#### Example + +```json +{ + "quote_comment": "abc123", + "quote_name": "xyz789", + "quote_uid": 4 +} +``` + + + +### RenameNegotiableQuoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after updating the name. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### ReorderItemsOutput + +Contains the cart and any errors after adding products. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | Detailed information about the customer's cart. | +| `userInputErrors` - [`[CheckoutUserInputError]!`](#checkoutuserinputerror) | An array of reordering errors. | + +#### Example + +```json +{ + "cart": Cart, + "userInputErrors": [CheckoutUserInputError] +} +``` + + + +### RequestGuestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `token` - [`String!`](#string) | Order token. | + +#### Example + +```json +{ + "comment_text": "xyz789", + "contact_email": "abc123", + "items": [RequestReturnItemInput], + "token": "abc123" +} +``` + + + +### RequestNegotiableQuoteInput + +Defines properties of a negotiable quote request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the buyer requesting a new negotiable quote. | +| `comment` - [`NegotiableQuoteCommentInput!`](#negotiablequotecommentinput) | Comments the buyer entered to describe the request. | +| `is_draft` - [`Boolean`](#boolean) | Flag indicating if quote is draft or not. | +| `quote_name` - [`String!`](#string) | The name the buyer assigned to the negotiable quote request. | + +#### Example + +```json +{ + "cart_id": "4", + "comment": NegotiableQuoteCommentInput, + "is_draft": false, + "quote_name": "abc123" +} +``` + + + +### RequestNegotiableQuoteOutput + +Contains the `NegotiableQuote` object generated when a buyer requests a negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | Details about the negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### RequestNegotiableQuoteTemplateInput + +Defines properties of a negotiable quote template request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`ID!`](#id) | The cart ID of the quote to create the new negotiable quote template from. | + +#### Example + +```json +{"cart_id": 4} +``` + + + +### RequestReturnInput + +Contains information needed to start a return request. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment_text` - [`String`](#string) | Text the buyer entered that describes the reason for the refund request. | +| `contact_email` - [`String`](#string) | The email address the buyer enters to receive notifications about the status of the return. | +| `items` - [`[RequestReturnItemInput]!`](#requestreturniteminput) | An array of items to be returned. | +| `order_uid` - [`ID!`](#id) | The unique ID for a `Order` object. | + +#### Example + +```json +{ + "comment_text": "abc123", + "contact_email": "abc123", + "items": [RequestReturnItemInput], + "order_uid": 4 +} +``` + + + +### RequestReturnItemInput + +Contains details about an item to be returned. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_custom_attributes` - [`[EnteredCustomAttributeInput]`](#enteredcustomattributeinput) | Details about a custom attribute that was entered. | +| `order_item_uid` - [`ID!`](#id) | The unique ID for a `OrderItemInterface` object. | +| `quantity_to_return` - [`Float!`](#float) | The quantity of the item to be returned. | +| `selected_custom_attributes` - [`[SelectedCustomAttributeInput]`](#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 + +```json +{ + "entered_custom_attributes": [ + EnteredCustomAttributeInput + ], + "order_item_uid": 4, + "quantity_to_return": 123.45, + "selected_custom_attributes": [ + SelectedCustomAttributeInput + ] +} +``` + + + +### RequestReturnOutput + +Contains the response to a return request. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `return` - [`Return`](#return) | Details about a single return request. | +| `returns` - [`Returns`](#returns) | An array of return requests. | + +#### Example + +```json +{ + "return": Return, + "returns": Returns +} +``` + + + +### RequisitionList + +Defines the contents of a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `description` - [`String`](#string) | Optional text that describes the requisition list. | +| `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. | +| `items_count` - [`Int!`](#int) | The number of items in the list. | +| `name` - [`String!`](#string) | The requisition list name. | +| `uid` - [`ID!`](#id) | The unique requisition list ID. | +| `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | + +#### Example + +```json +{ + "description": "xyz789", + "items": RequistionListItems, + "items_count": 987, + "name": "abc123", + "uid": "4", + "updated_at": "xyz789" +} +``` + + + +### RequisitionListFilterInput + +Defines requisition list filters. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `name` - [`FilterMatchTypeInput`](#filtermatchtypeinput) | Filter by the display name of the requisition list. | +| `uids` - [`FilterEqualTypeInput`](#filterequaltypeinput) | Filter requisition lists by one or more requisition list IDs. | + +#### Example + +```json +{ + "name": FilterMatchTypeInput, + "uids": FilterEqualTypeInput +} +``` + + + +### RequisitionListItemInterface + +The interface for requisition list items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The amount added. | +| `sku` - [`String!`](#string) | The product SKU. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Possible Types + +| RequisitionListItemInterface Types | +|----------------| +| [`BundleRequisitionListItem`](#bundlerequisitionlistitem) | +| [`ConfigurableRequisitionListItem`](#configurablerequisitionlistitem) | +| [`DownloadableRequisitionListItem`](#downloadablerequisitionlistitem) | +| [`GiftCardRequisitionListItem`](#giftcardrequisitionlistitem) | +| [`SimpleRequisitionListItem`](#simplerequisitionlistitem) | +| [`VirtualRequisitionListItem`](#virtualrequisitionlistitem) | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "sku": "abc123", + "uid": "4" +} +``` + + + +### RequisitionListItemsInput + +Defines the items to add. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `entered_options` - [`[EnteredOptionInput]`](#enteredoptioninput) | Entered option IDs. | +| `parent_sku` - [`String`](#string) | For configurable products, the SKU of the parent product. | +| `quantity` - [`Float`](#float) | The quantity of the product to add. | +| `selected_options` - [`[String]`](#string) | Selected option IDs. | +| `sku` - [`String!`](#string) | The product SKU. | + +#### Example + +```json +{ + "entered_options": [EnteredOptionInput], + "parent_sku": "abc123", + "quantity": 123.45, + "selected_options": ["xyz789"], + "sku": "abc123" +} +``` + + + +### RequisitionListSortInput + +Defines the field to use to sort a list of requisition lists. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `sort_direction` - [`SortEnum`](#sortenum) | Whether to return results in ascending or descending order. | +| `sort_field` - [`RequisitionListSortableField!`](#requisitionlistsortablefield) | The specified sort field. | + +#### Example + +```json +{"sort_direction": "ASC", "sort_field": "NAME"} +``` + + + +### RequisitionListSortableField + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NAME` | Sorts requisition lists by requisition list name. | +| `UPDATED_AT` | Sorts requisition lists by the date they were last updated. | + +#### Example + +```json +""NAME"" +``` + + + +### RequisitionLists + +Defines customer requisition lists. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionList]`](#requisitionlist) | An array of requisition lists. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `sort_fields` - [`SortFields`](#sortfields) | Contains the default sort field and all available sort fields. | +| `total_count` - [`Int`](#int) | The number of returned requisition lists. | + +#### Example + +```json +{ + "items": [RequisitionList], + "page_info": SearchResultPageInfo, + "sort_fields": SortFields, + "total_count": 123 +} +``` + + + +### RequistionListItems + +Contains an array of items added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[RequisitionListItemInterface]!`](#requisitionlistiteminterface) | An array of items in the requisition list. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_pages` - [`Int!`](#int) | The number of pages returned. | + +#### Example + +```json +{ + "items": [RequisitionListItemInterface], + "page_info": SearchResultPageInfo, + "total_pages": 123 +} +``` + + + +### Return + +Contains details about a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_carriers` - [`[ReturnShippingCarrier]`](#returnshippingcarrier) | A list of shipping carriers available for returns. | +| `comments` - [`[ReturnComment]`](#returncomment) | A list of comments posted for the return request. | +| `created_at` - [`String!`](#string) | The date the return was requested. | +| `customer` - [`ReturnCustomer!`](#returncustomer) | Data from the customer who created the return request. | +| `items` - [`[ReturnItem]`](#returnitem) | A list of items being returned. | +| `number` - [`String!`](#string) | A human-readable return number. | +| `order` - [`CustomerOrder`](#customerorder) | The order associated with the return. | +| `shipping` - [`ReturnShipping`](#returnshipping) | Shipping information for the return. | +| `status` - [`ReturnStatus`](#returnstatus) | The status of the return request. | +| `uid` - [`ID!`](#id) | The unique ID for a `Return` object. | + +#### Example + +```json +{ + "available_shipping_carriers": [ReturnShippingCarrier], + "comments": [ReturnComment], + "created_at": "xyz789", + "customer": ReturnCustomer, + "items": [ReturnItem], + "number": "abc123", + "order": CustomerOrder, + "shipping": ReturnShipping, + "status": "PENDING", + "uid": "4" +} +``` + + + +### ReturnComment + +Contains details about a return comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `author_name` - [`String!`](#string) | The name or author who posted the comment. | +| `created_at` - [`String!`](#string) | The date and time the comment was posted. | +| `text` - [`String!`](#string) | The contents of the comment. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnComment` object. | + +#### Example + +```json +{ + "author_name": "xyz789", + "created_at": "xyz789", + "text": "abc123", + "uid": "4" +} +``` + + + +### ReturnCustomer + +The customer information for the return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `email` - [`String!`](#string) | The email address of the customer. | +| `firstname` - [`String`](#string) | The first name of the customer. | +| `lastname` - [`String`](#string) | The last name of the customer. | + +#### Example + +```json +{ + "email": "xyz789", + "firstname": "xyz789", + "lastname": "xyz789" +} +``` + + + +### ReturnItem + +Contains details about a product being returned. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `custom_attributesV2` - [`[AttributeValueInterface]`](#attributevalueinterface) | Custom attributes that are visible on the storefront. | +| `order_item` - [`OrderItemInterface!`](#orderiteminterface) | Provides access to the product being returned, including information about selected and entered options. | +| `quantity` - [`Float!`](#float) | The quantity of the item the merchant authorized to be returned. | +| `request_quantity` - [`Float!`](#float) | The quantity of the item requested to be returned. | +| `status` - [`ReturnItemStatus!`](#returnitemstatus) | The return status of the item. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnItem` object. | + +#### Example + +```json +{ + "custom_attributesV2": [AttributeValueInterface], + "order_item": OrderItemInterface, + "quantity": 123.45, + "request_quantity": 123.45, + "status": "PENDING", + "uid": "4" +} +``` + + + +### ReturnItemAttributeMetadata + +Return Item attribute metadata. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ID!`](#id) | The unique identifier for an attribute code. This value should be in lowercase letters without spaces. | +| `default_value` - [`String`](#string) | Default attribute value. | +| `entity_type` - [`AttributeEntityTypeEnum!`](#attributeentitytypeenum) | The type of entity that defines the attribute. | +| `frontend_class` - [`String`](#string) | The frontend class of the attribute. | +| `frontend_input` - [`AttributeFrontendInputEnum`](#attributefrontendinputenum) | The frontend input type of the attribute. | +| `input_filter` - [`InputFilterEnum`](#inputfilterenum) | The template used for the input of the attribute (e.g., 'date'). | +| `is_required` - [`Boolean!`](#boolean) | Whether the attribute value is required. | +| `is_unique` - [`Boolean!`](#boolean) | Whether the attribute value must be unique. | +| `label` - [`String`](#string) | The label assigned to the attribute. | +| `multiline_count` - [`Int`](#int) | The number of lines of the attribute value. | +| `options` - [`[CustomAttributeOptionInterface]!`](#customattributeoptioninterface) | Attribute options. | +| `sort_order` - [`Int`](#int) | The position of the attribute in the form. | +| `validate_rules` - [`[ValidationRule]`](#validationrule) | The validation rules of the attribute value. | + +#### Example + +```json +{ + "code": 4, + "default_value": "xyz789", + "entity_type": "CATALOG_PRODUCT", + "frontend_class": "xyz789", + "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] +} +``` + + + +### ReturnItemStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `AUTHORIZED` | | +| `RECEIVED` | | +| `APPROVED` | | +| `REJECTED` | | +| `DENIED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### ReturnShipping + +Contains details about the return shipping address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `address` - [`ReturnShippingAddress`](#returnshippingaddress) | The merchant-defined return shipping address. | +| `tracking` - [`[ReturnShippingTracking]`](#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. | + +#### Example + +```json +{ + "address": ReturnShippingAddress, + "tracking": [ReturnShippingTracking] +} +``` + + + +### ReturnShippingAddress + +Contains details about the shipping address used for receiving returned items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `city` - [`String!`](#string) | The city for product returns. | +| `contact_name` - [`String`](#string) | The merchant's contact person. | +| `country` - [`Country!`](#country) | An object that defines the country for product returns. | +| `postcode` - [`String!`](#string) | The postal code for product returns. | +| `region` - [`Region!`](#region) | An object that defines the state or province for product returns. | +| `street` - [`[String]!`](#string) | The street address for product returns. | +| `telephone` - [`String`](#string) | The telephone number for product returns. | + +#### Example + +```json +{ + "city": "abc123", + "contact_name": "xyz789", + "country": Country, + "postcode": "abc123", + "region": Region, + "street": ["xyz789"], + "telephone": "abc123" +} +``` + + + +### ReturnShippingCarrier + +Contains details about the carrier on a return. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | A description of the shipping carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingCarrier` object assigned to the shipping carrier. | + +#### Example + +```json +{ + "label": "xyz789", + "uid": "4" +} +``` + + + +### ReturnShippingTracking + +Contains shipping and tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`ReturnShippingCarrier!`](#returnshippingcarrier) | Contains details of a shipping carrier. | +| `status` - [`ReturnShippingTrackingStatus`](#returnshippingtrackingstatus) | Details about the status of a shipment. | +| `tracking_number` - [`String!`](#string) | A tracking number assigned by the carrier. | +| `uid` - [`ID!`](#id) | The unique ID for a `ReturnShippingTracking` object assigned to the tracking item. | + +#### Example + +```json +{ + "carrier": ReturnShippingCarrier, + "status": ReturnShippingTrackingStatus, + "tracking_number": "xyz789", + "uid": "4" +} +``` + + + +### ReturnShippingTrackingStatus + +Contains the status of a shipment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `text` - [`String!`](#string) | Text that describes the status. | +| `type` - [`ReturnShippingTrackingStatusType!`](#returnshippingtrackingstatustype) | Indicates whether the status type is informational or an error. | + +#### Example + +```json +{"text": "abc123", "type": "INFORMATION"} +``` + + + +### ReturnShippingTrackingStatusType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `INFORMATION` | | +| `ERROR` | | + +#### Example + +```json +""INFORMATION"" +``` + + + +### ReturnStatus + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `PENDING` | | +| `UNCONFIRMED` | | +| `AUTHORIZED` | | +| `PARTIALLY_AUTHORIZED` | | +| `RECEIVED` | | +| `PARTIALLY_RECEIVED` | | +| `APPROVED` | | +| `PARTIALLY_APPROVED` | | +| `REJECTED` | | +| `PARTIALLY_REJECTED` | | +| `DENIED` | | +| `PROCESSED_AND_CLOSED` | | +| `CLOSED` | | + +#### Example + +```json +""PENDING"" +``` + + + +### Returns + +Contains a list of customer return requests. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[Return]`](#return) | A list of return requests. | +| `page_info` - [`SearchResultPageInfo`](#searchresultpageinfo) | Pagination metadata. | +| `total_count` - [`Int`](#int) | The total number of return requests. | + +#### Example + +```json +{ + "items": [Return], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + +### RevokeCustomerTokenOutput + +Contains the result of a request to revoke a customer token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `result` - [`Boolean!`](#boolean) | The result of a request to revoke a customer token. | + +#### Example + +```json +{"result": true} +``` + + + +### RewardPoints + +Contains details about a customer's reward points. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The current balance of reward points. | +| `balance_history` - [`[RewardPointsBalanceHistoryItem]`](#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`](#rewardpointsexchangerates) | The current exchange rates for reward points. | +| `subscription_status` - [`RewardPointsSubscriptionStatus`](#rewardpointssubscriptionstatus) | The subscription status of emails related to reward points. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "balance_history": [RewardPointsBalanceHistoryItem], + "exchange_rates": RewardPointsExchangeRates, + "subscription_status": RewardPointsSubscriptionStatus +} +``` + + + +### RewardPointsAmount + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `money` - [`Money!`](#money) | The reward points amount in store currency. | +| `points` - [`Float!`](#float) | The reward points amount in points. | + +#### Example + +```json +{"money": Money, "points": 123.45} +``` + + + +### RewardPointsBalanceHistoryItem + +Contain details about the reward points transaction. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance` - [`RewardPointsAmount`](#rewardpointsamount) | The award points balance after the completion of the transaction. | +| `change_reason` - [`String!`](#string) | The reason the balance changed. | +| `date` - [`String!`](#string) | The date of the transaction. | +| `points_change` - [`Float!`](#float) | The number of points added or deducted in the transaction. | + +#### Example + +```json +{ + "balance": RewardPointsAmount, + "change_reason": "xyz789", + "date": "xyz789", + "points_change": 987.65 +} +``` + + + +### RewardPointsExchangeRates + +Lists the reward points exchange rates. The values depend on the customer group. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `earning` - [`RewardPointsRate`](#rewardpointsrate) | How many points are earned for a given amount spent. | +| `redemption` - [`RewardPointsRate`](#rewardpointsrate) | How many points must be redeemed to get a given amount of currency discount at the checkout. | + +#### Example + +```json +{ + "earning": RewardPointsRate, + "redemption": RewardPointsRate +} +``` + + + +### RewardPointsRate + +Contains details about customer's reward points rate. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `currency_amount` - [`Float!`](#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!`](#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 + +```json +{"currency_amount": 987.65, "points": 123.45} +``` + + + +### RewardPointsSubscriptionStatus + +Indicates whether the customer subscribes to reward points emails. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `balance_updates` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points balance updates' emails. | +| `points_expiration_notifications` - [`RewardPointsSubscriptionStatusesEnum!`](#rewardpointssubscriptionstatusesenum) | Indicates whether the customer subscribes to 'Reward points expiration notifications' emails. | + +#### Example + +```json +{ + "balance_updates": "SUBSCRIBED", + "points_expiration_notifications": "SUBSCRIBED" +} +``` + + + +### RewardPointsSubscriptionStatusesEnum + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `SUBSCRIBED` | | +| `NOT_SUBSCRIBED` | | + +#### Example + +```json +""SUBSCRIBED"" +``` + + + +### SDKParams + +Defines the name and value of a SDK parameter + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `name` - [`String`](#string) | The name of the SDK parameter | +| `value` - [`String`](#string) | The value of the SDK parameter | + +#### Example + +```json +{ + "name": "xyz789", + "value": "xyz789" +} +``` + + + +### SalesCommentItem + +Contains details about a comment. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `message` - [`String!`](#string) | The text of the message. | +| `timestamp` - [`String!`](#string) | The timestamp of the comment. | + +#### Example + +```json +{ + "message": "abc123", + "timestamp": "abc123" +} +``` + + + +### ScalarBucket + +For use on string and other scalar product fields + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `count` - [`Int!`](#int) | The number of items in the bucket | +| `id` - [`ID!`](#id) | An identifier that can be used for filtering. It may contain non-human readable data | +| `title` - [`String!`](#string) | The display text for the scalar value | + +#### Example + +```json +{"count": 987, "id": 4, "title": "xyz789"} +``` + + + +### ScopeTypeEnum + +This enumeration defines the scope type for customer orders. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `GLOBAL` | | +| `WEBSITE` | | +| `STORE` | | + +#### Example + +```json +""GLOBAL"" +``` + + + +### SearchClauseInput + +A product attribute to filter on + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute` - [`String!`](#string) | The attribute code of a product attribute | +| `contains` - [`String`](#string) | attribute value should contain the specified string | +| `eq` - [`String`](#string) | A string value to filter on | +| `in` - [`[String]`](#string) | An array of string values to filter on | +| `range` - [`SearchRangeInput`](#searchrangeinput) | A range of numeric values to filter on | +| `startsWith` - [`String`](#string) | attribute value should start with the specified string | + +#### Example + +```json +{ + "attribute": "xyz789", + "contains": "abc123", + "eq": "abc123", + "in": ["abc123"], + "range": SearchRangeInput, + "startsWith": "abc123" +} +``` + + + +### SearchRangeInput + +A range of numeric values for use in a search + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `from` - [`Float`](#float) | The minimum value to filter on. If not specified, the value of `0` is applied | +| `to` - [`Float`](#float) | The maximum value to filter on | + +#### Example + +```json +{"from": 987.65, "to": 123.45} +``` + + + +### SearchResultPageInfo + +Provides navigation for the query response. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `current_page` - [`Int`](#int) | The specific page to return. | +| `page_size` - [`Int`](#int) | The maximum number of items to return per page of results. | +| `total_pages` - [`Int`](#int) | The total number of pages in the response. | + +#### Example + +```json +{"current_page": 123, "page_size": 123, "total_pages": 123} +``` + + + +### SelectedBundleOption + +Contains details about a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The display name of the selected bundle product option. | +| `type` - [`String!`](#string) | The type of selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOption` object | +| `values` - [`[SelectedBundleOptionValue]!`](#selectedbundleoptionvalue) | An array of selected bundle option values. | + +#### Example + +```json +{ + "label": "xyz789", + "type": "abc123", + "uid": "4", + "values": [SelectedBundleOptionValue] +} +``` + + + +### SelectedBundleOptionValue + +Contains details about a value for a selected bundle option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String!`](#string) | The display name of the value for the selected bundle product option. | +| `original_price` - [`Money!`](#money) | The original price of the value for the selected bundle product option. | +| `priceV2` - [`Money!`](#money) | The price of the value for the selected bundle product option. | +| `quantity` - [`Float!`](#float) | The quantity of the value for the selected bundle product option. | +| `uid` - [`ID!`](#id) | The unique ID for a `SelectedBundleOptionValue` object | + +#### Example + +```json +{ + "label": "abc123", + "original_price": Money, + "priceV2": Money, + "quantity": 123.45, + "uid": "4" +} +``` + + + +### SelectedConfigurableOption + +Contains details about a selected configurable option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `configurable_product_option_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptions` object. | +| `configurable_product_option_value_uid` - [`ID!`](#id) | The unique ID for a `ConfigurableProductOptionsValues` object. | +| `option_label` - [`String!`](#string) | The display text for the option. | +| `value_label` - [`String!`](#string) | The display name of the selected configurable option. | + +#### Example + +```json +{ + "configurable_product_option_uid": "4", + "configurable_product_option_value_uid": "4", + "option_label": "xyz789", + "value_label": "abc123" +} +``` + + + +### SelectedCustomAttributeInput + +Contains details about an attribute the buyer selected. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attribute_code` - [`String!`](#string) | A string that identifies the selected attribute. | +| `value` - [`String!`](#string) | The unique ID for a selected custom attribute value. | + +#### Example + +```json +{ + "attribute_code": "abc123", + "value": "xyz789" +} +``` + + + +### SelectedCustomizableOption + +Identifies a customized product that has been placed in a cart. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_uid` - [`ID!`](#id) | The unique ID for a specific `CustomizableOptionInterface` object, such as a `CustomizableFieldOption`, `CustomizableFileOption`, or `CustomizableAreaOption` object. | +| `is_required` - [`Boolean!`](#boolean) | Indicates whether the customizable option is required. | +| `label` - [`String!`](#string) | The display name of the selected customizable option. | +| `sort_order` - [`Int!`](#int) | A value indicating the order to display this option. | +| `type` - [`String!`](#string) | The type of `CustomizableOptionInterface` object. | +| `values` - [`[SelectedCustomizableOptionValue]!`](#selectedcustomizableoptionvalue) | An array of selectable values. | + +#### Example + +```json +{ + "customizable_option_uid": 4, + "is_required": false, + "label": "xyz789", + "sort_order": 987, + "type": "abc123", + "values": [SelectedCustomizableOptionValue] +} +``` + + + +### SelectedCustomizableOptionValue + +Identifies the value of the selected customized option. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_option_value_uid` - [`ID!`](#id) | The unique ID for a value object that corresponds to the object represented by the `customizable_option_uid` attribute. | +| `label` - [`String!`](#string) | The display name of the selected value. | +| `price` - [`CartItemSelectedOptionValuePrice!`](#cartitemselectedoptionvalueprice) | The price of the selected customizable value. | +| `value` - [`String!`](#string) | The text identifying the selected value. | + +#### Example + +```json +{ + "customizable_option_value_uid": 4, + "label": "xyz789", + "price": CartItemSelectedOptionValuePrice, + "value": "xyz789" +} +``` + + + +### SelectedPaymentMethod + +Describes the payment method selected by the shopper. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`String!`](#string) | The payment method code. | +| `oope_payment_method_config` - [`OopePaymentMethodConfig`](#oopepaymentmethodconfig) | Configuration for out of process payment methods | +| `purchase_order_number` - [`String`](#string) | The purchase order number. | +| `title` - [`String!`](#string) | The payment method title. | + +#### Example + +```json +{ + "code": "xyz789", + "oope_payment_method_config": OopePaymentMethodConfig, + "purchase_order_number": "xyz789", + "title": "abc123" +} +``` + + + +### SelectedShippingMethod + +Contains details about the selected shipping method and carrier. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `additional_data` - [`[ShippingAdditionalData]`](#shippingadditionaldata) | Additional data related to the shipping method. | +| `amount` - [`Money!`](#money) | The cost of shipping using this shipping method. | +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline shipping method. | +| `carrier_title` - [`String!`](#string) | The label for the carrier code. | +| `method_code` - [`String!`](#string) | A shipping method code associated with a carrier. | +| `method_title` - [`String!`](#string) | The label for the method code. | +| `price_excl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, excluding tax. | +| `price_incl_tax` - [`Money!`](#money) | The cost of shipping using this shipping method, including tax. | + +#### Example + +```json +{ + "additional_data": [ShippingAdditionalData], + "amount": Money, + "carrier_code": "abc123", + "carrier_title": "xyz789", + "method_code": "xyz789", + "method_title": "xyz789", + "price_excl_tax": Money, + "price_incl_tax": Money +} +``` + + + +### SendNegotiableQuoteForReviewInput + +Specifies which negotiable quote to send for review. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `comment` - [`NegotiableQuoteCommentInput`](#negotiablequotecommentinput) | A comment for the seller to review. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "comment": NegotiableQuoteCommentInput, + "quote_uid": "4" +} +``` + + + +### SendNegotiableQuoteForReviewOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetBillingAddressOnCartInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`BillingAddressInput!`](#billingaddressinput) | The billing address. | +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | + +#### Example + +```json +{ + "billing_address": BillingAddressInput, + "cart_id": "xyz789" +} +``` + + + +### SetBillingAddressOnCartOutput + +Contains details about the cart after setting the billing address. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the billing address. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetCartAsInactiveOutput + +Sets the cart as inactive + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `error` - [`String`](#string) | The error message returned after failing to set the cart as inactive | +| `success` - [`Boolean!`](#boolean) | Indicates whether the cart was set as inactive | + +#### Example + +```json +{"error": "abc123", "success": false} +``` + + + +### SetCustomAttributesOnCompanyInput + +Defines the company custom attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for company. | +| `id` - [`ID!`](#id) | The unique ID of a `company` object. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttributeInput], + "id": "4" +} +``` + + + +### SetCustomAttributesOnCompanyOutput + +Contains the company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company` - [`Company`](#company) | The company after assigning custom attributes. | + +#### Example + +```json +{"company": Company} +``` + + + +### SetCustomAttributesOnNegotiableQuoteInput + +Defines the negotiable quote custom attributes. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `custom_attributes` - [`[CustomAttributeInput]`](#customattributeinput) | An array of custom attributes for NegotiableQuote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "custom_attributes": [CustomAttributeInput], + "quote_uid": "4" +} +``` + + + +### SetCustomAttributesOnNegotiableQuoteOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning custom attributes. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetGiftOptionsOnCartInput + +Defines the gift options applied to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID that identifies the shopper's cart. | +| `gift_message` - [`GiftMessageInput`](#giftmessageinput) | Gift message details for the cart. | +| `gift_receipt_included` - [`Boolean!`](#boolean) | Whether customer requested gift receipt for the cart. | +| `gift_wrapping_id` - [`ID`](#id) | The unique ID for a `GiftWrapping` object to be used for the cart. | +| `printed_card_included` - [`Boolean!`](#boolean) | Whether customer requested printed card for the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "gift_message": GiftMessageInput, + "gift_receipt_included": false, + "gift_wrapping_id": "4", + "printed_card_included": true +} +``` + + + +### SetGiftOptionsOnCartOutput + +Contains the cart after gift options have been applied. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The modified cart object. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetGuestEmailOnCartInput + +Defines the guest email and cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `email` - [`String!`](#string) | The email address of the guest. | + +#### Example + +```json +{ + "cart_id": "abc123", + "email": "xyz789" +} +``` + + + +### SetGuestEmailOnCartOutput + +Contains details about the cart after setting the email of a guest. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the guest email. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetLineItemNoteOutput + +Contains the updated negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after sending for seller review. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteBillingAddressInput + +Sets the billing address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `billing_address` - [`NegotiableQuoteBillingAddressInput!`](#negotiablequotebillingaddressinput) | The billing address to be added. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "billing_address": NegotiableQuoteBillingAddressInput, + "quote_uid": "4" +} +``` + + + +### SetNegotiableQuoteBillingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a billing address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuotePaymentMethodInput + +Defines the payment method of the specified negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_method` - [`NegotiableQuotePaymentMethodInput!`](#negotiablequotepaymentmethodinput) | The payment method to be assigned to the negotiable quote. | +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "payment_method": NegotiableQuotePaymentMethodInput, + "quote_uid": 4 +} +``` + + + +### SetNegotiableQuotePaymentMethodOutput + +Contains details about the negotiable quote after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The updated negotiable quote. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingAddressInput + +Defines the shipping address to assign to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_addresses` - [`[NegotiableQuoteShippingAddressInput]`](#negotiablequoteshippingaddressinput) | An array of shipping addresses to apply to the negotiable quote. | + +#### Example + +```json +{ + "quote_uid": 4, + "shipping_addresses": [ + NegotiableQuoteShippingAddressInput + ] +} +``` + + + +### SetNegotiableQuoteShippingAddressOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after assigning a shipping address. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteShippingMethodsInput + +Defines the shipping method to apply to the negotiable quote. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `quote_uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods to apply to the negotiable quote. | + +#### Example + +```json +{ + "quote_uid": 4, + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetNegotiableQuoteShippingMethodsOutput + +Contains the negotiable quote. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `quote` - [`NegotiableQuote`](#negotiablequote) | The negotiable quote after applying shipping methods. | + +#### Example + +```json +{"quote": NegotiableQuote} +``` + + + +### SetNegotiableQuoteTemplateShippingAddressInput + +Defines the shipping address to assign to the negotiable quote template. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `shipping_address` - [`NegotiableQuoteTemplateShippingAddressInput!`](#negotiablequotetemplateshippingaddressinput) | A shipping adadress to apply to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuote` object. | + +#### Example + +```json +{ + "shipping_address": NegotiableQuoteTemplateShippingAddressInput, + "template_id": "4" +} +``` + + + +### SetPaymentMethodOnCartInput + +Applies a payment method to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `payment_method` - [`PaymentMethodInput!`](#paymentmethodinput) | The payment method data to apply to the cart. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "payment_method": PaymentMethodInput +} +``` + + + +### SetPaymentMethodOnCartOutput + +Contains details about the cart after setting the payment method. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the payment method. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingAddressesOnCartInput + +Specifies an array of addresses to use for shipping. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_addresses` - [`[ShippingAddressInput]!`](#shippingaddressinput) | An array of shipping addresses. | + +#### Example + +```json +{ + "cart_id": "abc123", + "shipping_addresses": [ShippingAddressInput] +} +``` + + + +### SetShippingAddressesOnCartOutput + +Contains details about the cart after setting the shipping addresses. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping addresses. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### SetShippingMethodsOnCartInput + +Applies one or shipping methods to the cart. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](#string) | The unique ID of a `Cart` object. | +| `shipping_methods` - [`[ShippingMethodInput]!`](#shippingmethodinput) | An array of shipping methods. | + +#### Example + +```json +{ + "cart_id": "abc123", + "shipping_methods": [ShippingMethodInput] +} +``` + + + +### SetShippingMethodsOnCartOutput + +Contains details about the cart after setting the shipping methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](#cart) | The cart after setting the shipping methods. | + +#### Example + +```json +{"cart": Cart} +``` + + + +### ShareGiftRegistryInviteeInput + +Defines a gift registry invitee. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `email` - [`String!`](#string) | The email address of the gift registry invitee. | +| `name` - [`String!`](#string) | The name of the gift registry invitee. | + +#### Example + +```json +{ + "email": "abc123", + "name": "abc123" +} +``` + + + +### ShareGiftRegistryOutput + +Contains the results of a request to share a gift registry. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `is_shared` - [`Boolean!`](#boolean) | Indicates whether the gift registry was successfully shared. | + +#### Example + +```json +{"is_shared": true} +``` + + + +### ShareGiftRegistrySenderInput + +Defines the sender of an invitation to view a gift registry. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `message` - [`String!`](#string) | A brief message from the sender. | +| `name` - [`String!`](#string) | The sender of the gift registry invitation. | + +#### Example + +```json +{ + "message": "abc123", + "name": "abc123" +} +``` + + + +### ShareRequisitionListByEmailInput + +An input object that defines which requisition list shared with company users through email. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customerUids` - [`[ID]!`](#id) | An array of IDs representing company users with whom the sender wants to share the requisition list. | +| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | + +#### Example + +```json +{ + "customerUids": ["4"], + "requisitionListUid": "4" +} +``` + + + +### ShareRequisitionListByEmailOutput + +Result of sharing a requisition list by email. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sent_count` - [`Int!`](#int) | Number of notification emails successfully sent. | +| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Per-email validation or delivery issues. | + +#### Example + +```json +{ + "sent_count": 987, + "user_errors": [ShareRequisitionListUserError] +} +``` + + + +### ShareRequisitionListByTokenOutput + +The result of sharing a requisition list by token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `token` - [`String!`](#string) | Token used to generate a shareable link for the requisition list. | + +#### Example + +```json +{"token": "xyz789"} +``` + + + +### ShareRequisitionListUserError + +An error related to a specific recipient or constraint. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ShareRequisitionListUserErrorCode!`](#sharerequisitionlistusererrorcode) | Machine-readable error code. | +| `message` - [`String!`](#string) | Human-readable error message. | + +#### Example + +```json +{ + "code": "MAX_RECIPIENTS_EXCEEDED", + "message": "xyz789" +} +``` + + + +### ShareRequisitionListUserErrorCode + +Machine-readable error codes for requisition list share-by-email and import operations. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `MAX_RECIPIENTS_EXCEEDED` | | +| `INVALID_EMAIL` | | +| `NOT_COMPANY_USER` | | +| `IMPORT_FAILED` | | + +#### Example + +```json +""MAX_RECIPIENTS_EXCEEDED"" +``` + + + +### SharedRequisitionListOutput + +Shared requisition list view for a recipient. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList!`](#requisitionlist) | The sender's requisition list (read-only for the recipient). | +| `sender_name` - [`String!`](#string) | Display name of the requisition list sender. | + +#### Example + +```json +{ + "requisition_list": RequisitionList, + "sender_name": "xyz789" +} +``` + + + +### ShipBundleItemsEnum + +Defines whether bundle items must be shipped together. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TOGETHER` | | +| `SEPARATELY` | | + +#### Example + +```json +""TOGETHER"" +``` + + + +### ShipmentItem + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Example + +```json +{ + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 123.45 +} +``` + + + +### ShipmentItemInterface + +Order shipment item details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `id` - [`ID!`](#id) | The unique ID for a `ShipmentItemInterface` object. | +| `order_item` - [`OrderItemInterface`](#orderiteminterface) | The order item associated with the shipment item. | +| `product_name` - [`String`](#string) | The name of the base product. | +| `product_sale_price` - [`Money!`](#money) | The sale price for the base product. | +| `product_sku` - [`String!`](#string) | The SKU of the base product. | +| `quantity_shipped` - [`Float!`](#float) | The number of shipped items. | + +#### Possible Types + +| ShipmentItemInterface Types | +|----------------| +| [`BundleShipmentItem`](#bundleshipmentitem) | +| [`GiftCardShipmentItem`](#giftcardshipmentitem) | +| [`ShipmentItem`](#shipmentitem) | + +#### Example + +```json +{ + "id": 4, + "order_item": OrderItemInterface, + "product_name": "abc123", + "product_sale_price": Money, + "product_sku": "abc123", + "quantity_shipped": 123.45 +} +``` + + + +### ShipmentTracking + +Contains order shipment tracking details. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | +| `number` - [`String`](#string) | The tracking number of the order shipment. | +| `title` - [`String!`](#string) | The shipment tracking title. | +| `tracking_url` - [`String`](#string) | The tracking URL for the shipment. Available for both built-in and custom shipping carriers when a URL template is configured. | + +#### Example + +```json +{ + "carrier": "xyz789", + "number": "abc123", + "title": "xyz789", + "tracking_url": "xyz789" +} +``` + + + +### ShippingAdditionalData + +A simple key value object. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `key` - [`String`](#string) | | +| `value` - [`String`](#string) | | + +#### Example + +```json +{ + "key": "abc123", + "value": "abc123" +} +``` + + + +### ShippingAddressInput + +Defines a single shipping address. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `address` - [`CartAddressInput`](#cartaddressinput) | Defines a shipping address. | +| `customer_address_id` - [`Int`](#int) | An ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address to be used for shipping. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `pickup_location_code` - [`String`](#string) | The code of Pickup Location which will be used for In-Store Pickup. | + +#### Example + +```json +{ + "address": CartAddressInput, + "customer_address_id": 123, + "customer_address_uid": 4, + "customer_notes": "xyz789", + "pickup_location_code": "xyz789" +} +``` + + + +### ShippingCartAddress + +Contains shipping addresses and methods. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_shipping_methods` - [`[AvailableShippingMethod]`](#availableshippingmethod) | An array that lists the shipping methods that can be applied to the cart. | +| `cart_items_v2` - [`[CartItemInterface]`](#cartiteminterface) | An array that lists the items in the cart. | +| `city` - [`String!`](#string) | The city specified for the billing or shipping address. | +| `company` - [`String`](#string) | The company specified for the billing or shipping address. | +| `country` - [`CartAddressCountry!`](#cartaddresscountry) | An object containing the country label and code. | +| `custom_attributes` - [`[AttributeValueInterface]!`](#attributevalueinterface) | The custom attribute values of the billing or shipping address. | +| `customer_address_uid` - [`ID`](#id) | The unique ID from the customer's address book that uniquely identifies the address. | +| `customer_notes` - [`String`](#string) | Text provided by the shopper. | +| `fax` - [`String`](#string) | The customer's fax number. | +| `firstname` - [`String!`](#string) | The first name of the customer or guest. | +| `id` - [`Int`](#int) | Id of the customer address. *(Deprecated: Use `customer_address_uid` instead.)* | +| `lastname` - [`String!`](#string) | The last name of the customer or guest. | +| `middlename` - [`String`](#string) | The middle name of the person associated with the billing/shipping address. | +| `pickup_location_code` - [`String`](#string) | | +| `postcode` - [`String`](#string) | The ZIP or postal code of the billing or shipping address. | +| `prefix` - [`String`](#string) | An honorific, such as Dr., Mr., or Mrs. | +| `region` - [`CartAddressRegion`](#cartaddressregion) | An object containing the region label and code. | +| `same_as_billing` - [`Boolean!`](#boolean) | Indicates whether the shipping address is same as billing address. | +| `selected_shipping_method` - [`SelectedShippingMethod`](#selectedshippingmethod) | An object that describes the selected shipping method. | +| `street` - [`[String]!`](#string) | An array containing the street for the billing or shipping address. | +| `suffix` - [`String`](#string) | A value such as Sr., Jr., or III. | +| `telephone` - [`String`](#string) | The telephone number for the billing or shipping address. | +| `uid` - [`ID!`](#id) | The unique id of the customer cart address. | +| `vat_id` - [`String`](#string) | The VAT company number for billing or shipping address. | + +#### Example + +```json +{ + "available_shipping_methods": [AvailableShippingMethod], + "cart_items_v2": [CartItemInterface], + "city": "xyz789", + "company": "xyz789", + "country": CartAddressCountry, + "custom_attributes": [AttributeValueInterface], + "customer_address_uid": 4, + "customer_notes": "xyz789", + "fax": "abc123", + "firstname": "abc123", + "id": 987, + "lastname": "xyz789", + "middlename": "xyz789", + "pickup_location_code": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", + "region": CartAddressRegion, + "same_as_billing": true, + "selected_shipping_method": SelectedShippingMethod, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "abc123", + "uid": 4, + "vat_id": "abc123" +} +``` + + + +### ShippingDiscount + +Defines an individual shipping discount. This discount can be applied to shipping. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount` - [`Money!`](#money) | The amount of the discount. | + +#### Example + +```json +{"amount": Money} +``` + + + +### ShippingHandling + +Contains details about shipping and handling costs. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `amount_excluding_tax` - [`Money`](#money) | The shipping amount, excluding tax. | +| `amount_including_tax` - [`Money`](#money) | The shipping amount, including tax. | +| `discounts` - [`[ShippingDiscount]`](#shippingdiscount) | The applied discounts to the shipping. | +| `taxes` - [`[TaxItem]`](#taxitem) | Details about taxes applied for shipping. | +| `total_amount` - [`Money!`](#money) | The total amount for shipping. | + +#### Example + +```json +{ + "amount_excluding_tax": Money, + "amount_including_tax": Money, + "discounts": [ShippingDiscount], + "taxes": [TaxItem], + "total_amount": Money +} +``` + + + +### ShippingMethodInput + +Defines the shipping carrier and method. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `carrier_code` - [`String!`](#string) | A string that identifies a commercial carrier or an offline delivery method. | +| `method_code` - [`String!`](#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 + +```json +{ + "carrier_code": "abc123", + "method_code": "xyz789" +} +``` + + + +### SimpleCartItem + +An implementation for simple product cart items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | +| `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | +| `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | +| `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | +| `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | +| `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | +| `max_qty` - [`Float`](#float) | Line item max qty in quote template | +| `min_qty` - [`Float`](#float) | Line item min qty in quote template | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | +| `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | +| `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | +| `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | +| `product` - [`ProductInterface!`](#productinterface) | Details about an item in the cart. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this item in the cart. | +| `uid` - [`ID!`](#id) | The unique ID for a `CartItemInterface` object. | + +#### Example + +```json +{ + "available_gift_wrapping": [GiftWrapping], + "backorder_message": "xyz789", + "custom_attributes": [CustomAttribute], + "customizable_options": [SelectedCustomizableOption], + "discount": [Discount], + "errors": [CartItemError], + "gift_message": GiftMessage, + "gift_wrapping": GiftWrapping, + "is_available": false, + "is_salable": false, + "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": 123.45, + "uid": "4" +} +``` + + + +### SimpleProduct + +Defines a simple product, which is tangible and is usually sold in single units or in fixed quantities. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `canonical_url` - [`String`](#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]`](#categoryinterface) | The categories assigned to a product. | +| `country_of_manufacture` - [`String`](#string) | The product's country of origin. | +| `crosssell_products` - [`[ProductInterface]`](#productinterface) | Crosssell Products | +| `custom_attributesV2` - [`ProductCustomAttributes`](#productcustomattributes) | Product custom attributes. | +| `description` - [`ComplexTextValue`](#complextextvalue) | Detailed information about the product. The value can include simple HTML tags. | +| `gift_message_available` - [`Boolean!`](#boolean) | Returns a value indicating gift message availability for the product. | +| `gift_wrapping_available` - [`Boolean!`](#boolean) | Returns a value indicating gift wrapping availability for the product. | +| `gift_wrapping_price` - [`Money`](#money) | Returns value and currency indicating gift wrapping price for the product. | +| `image` - [`ProductImage`](#productimage) | The relative path to the main image on the product page. | +| `is_returnable` - [`String`](#string) | Indicates whether the product can be returned. | +| `manufacturer` - [`Int`](#int) | A number representing the product's manufacturer. | +| `max_sale_qty` - [`Float`](#float) | Maximum Qty Allowed in Shopping Cart | +| `media_gallery` - [`[MediaGalleryInterface]`](#mediagalleryinterface) | An array of media gallery objects. | +| `meta_description` - [`String`](#string) | A brief overview of the product for search results listings, maximum 255 characters. | +| `meta_keyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `meta_title` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `min_sale_qty` - [`Float`](#float) | Minimum Qty Allowed in Shopping Cart | +| `name` - [`String`](#string) | The product name. Customers use this name to identify the product. | +| `new_from_date` - [`String`](#string) | The beginning date for new product listings, and determines if the product is featured as a new product. | +| `new_to_date` - [`String`](#string) | The end date for new product listings. | +| `only_x_left_in_stock` - [`Float`](#float) | Product stock only x left count | +| `options` - [`[CustomizableOptionInterface]`](#customizableoptioninterface) | An array of options for a customizable product. | +| `options_container` - [`String`](#string) | If the product has multiple options, determines where they appear on the product page. | +| `price_range` - [`PriceRange!`](#pricerange) | The range of prices for the product | +| `price_tiers` - [`[TierPrice]`](#tierprice) | An array of `TierPrice` objects. | +| `product_links` - [`[ProductLinksInterface]`](#productlinksinterface) | An array of `ProductLinks` objects. | +| `quantity` - [`Float`](#float) | Quantity of available stock | +| `related_products` - [`[ProductInterface]`](#productinterface) | An array of products to be displayed in a Related Products block. | +| `short_description` - [`ComplexTextValue`](#complextextvalue) | A short description of the product. Its use depends on the theme. | +| `sku` - [`String`](#string) | A number or code assigned to a product to identify the product, options, price, and manufacturer. | +| `small_image` - [`ProductImage`](#productimage) | The relative path to the small image, which is used on catalog pages. | +| `special_price` - [`Float`](#float) | The discounted price of the product. | +| `special_to_date` - [`String`](#string) | The end date for a product with a special price. | +| `stock_status` - [`ProductStockStatus`](#productstockstatus) | Stock status of the product | +| `swatch_image` - [`String`](#string) | The file name of a swatch image. | +| `thumbnail` - [`ProductImage`](#productimage) | The relative path to the product's thumbnail image. | +| `uid` - [`ID!`](#id) | The unique ID for a `ProductInterface` object. | +| `upsell_products` - [`[ProductInterface]`](#productinterface) | Upsell Products | +| `url_key` - [`String`](#string) | The part of the URL that identifies the product | +| `weight` - [`Float`](#float) | The weight of the item, in units defined by the store. | + +#### Example + +```json +{ + "canonical_url": "xyz789", + "categories": [CategoryInterface], + "country_of_manufacture": "xyz789", + "crosssell_products": [ProductInterface], + "custom_attributesV2": ProductCustomAttributes, + "description": ComplexTextValue, + "gift_message_available": true, + "gift_wrapping_available": false, + "gift_wrapping_price": Money, + "image": ProductImage, + "is_returnable": "abc123", + "manufacturer": 123, + "max_sale_qty": 123.45, + "media_gallery": [MediaGalleryInterface], + "meta_description": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", + "only_x_left_in_stock": 987.65, + "options": [CustomizableOptionInterface], + "options_container": "abc123", + "price_range": PriceRange, + "price_tiers": [TierPrice], + "product_links": [ProductLinksInterface], + "quantity": 987.65, + "related_products": [ProductInterface], + "short_description": ComplexTextValue, + "sku": "xyz789", + "small_image": ProductImage, + "special_price": 123.45, + "special_to_date": "abc123", + "stock_status": "IN_STOCK", + "swatch_image": "xyz789", + "thumbnail": ProductImage, + "uid": "4", + "upsell_products": [ProductInterface], + "url_key": "xyz789", + "weight": 987.65 +} +``` + + + +### SimpleProductView + +Represents a single-SKU product without selectable variants. Because there are no variant combinations, pricing is returned as a single price (not a price range). + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `addToCartAllowed` - [`Boolean`](#boolean) | A flag stating if the product can be added to cart *(Deprecated: This field is deprecated and will be removed.)* | +| `inStock` - [`Boolean`](#boolean) | A flag stating if the product is in stock *(Deprecated: This field is deprecated and will be removed.)* | +| `lowStock` - [`Boolean`](#boolean) | Indicates whether the remaining quantity of the product has reached the Only X Left threshold. *(Deprecated: This field is deprecated and will be removed.)* | +| `attributes` - [`[ProductViewAttribute]`](#productviewattribute) | A list of merchant-defined attributes designated for the storefront. They can be filtered by names and roles. | +| `description` - [`String`](#string) | The detailed description of the product. | +| `id` - [`ID!`](#id) | The product ID, generated as a composite key, unique per locale. | +| `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image`, and `swatch`. | +| `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | +| `inputOptions` - [`[ProductViewInputOption]`](#productviewinputoption) | A list of input options. For example, a text field, a number field or a date field. *(Deprecated: This field is deprecated and will be removed.)* | +| `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | +| `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | +| `metaKeyword` - [`String`](#string) | A comma-separated list of keywords that are visible only to search engines. | +| `metaTitle` - [`String`](#string) | A string that is displayed in the title bar and tab of the browser and in search results lists. | +| `name` - [`String`](#string) | Product name. | +| `price` - [`ProductViewPrice`](#productviewprice) | Base product price view. | +| `shortDescription` - [`String`](#string) | A summary of the product. | +| `sku` - [`String`](#string) | A unique code used for identification of a product. | +| `externalId` - [`String`](#string) | External Id. For example, `123`, `456` or `789`. *(Deprecated: This field is deprecated and will be removed.)* | +| `url` - [`String`](#string) | Canonical URL of the product. For example, `https://example.com/product-1` or `https://example.com/product-2`. *(Deprecated: This field is deprecated and will be removed.)* | +| `urlKey` - [`String`](#string) | The URL key of the product. For example, `product-1`, `product-2` or `product-3`. | +| `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. For example, a related product, an up-sell product or a cross-sell product. | +| `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | +| `visibility` - [`String`](#string) | Visibility setting of the product | + +#### Example + +```json +{ + "addToCartAllowed": false, + "inStock": true, + "lowStock": true, + "attributes": [ProductViewAttribute], + "description": "abc123", + "id": "4", + "images": [ProductViewImage], + "videos": [ProductViewVideo], + "inputOptions": [ProductViewInputOption], + "lastModifiedAt": "2007-12-03T10:15:30Z", + "metaDescription": "xyz789", + "metaKeyword": "abc123", + "metaTitle": "xyz789", + "name": "xyz789", + "price": ProductViewPrice, + "shortDescription": "xyz789", + "sku": "abc123", + "externalId": "abc123", + "url": "xyz789", + "urlKey": "xyz789", + "links": [ProductViewLink], + "queryType": "xyz789", + "visibility": "xyz789" +} +``` + + + +### SimpleRequisitionListItem + +Contains details about simple products added to a requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Selected custom options for an item in the requisition list. | +| `product` - [`ProductInterface!`](#productinterface) | Details about a requisition list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The amount added. | +| `sku` - [`String!`](#string) | The product SKU. | +| `uid` - [`ID!`](#id) | The unique ID for the requisition list item. | + +#### Example + +```json +{ + "customizable_options": [SelectedCustomizableOption], + "product": ProductInterface, + "quantity": 987.65, + "sku": "xyz789", + "uid": "4" +} +``` + + + +### SimpleWishlistItem + +Contains a simple product wish list item. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `added_at` - [`String!`](#string) | The date and time the item was added to the wish list. | +| `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | Custom options selected for the wish list item. | +| `description` - [`String`](#string) | The description of the item. | +| `id` - [`ID!`](#id) | The unique ID for a `WishlistItemInterface` object. | +| `product` - [`ProductInterface!`](#productinterface) | Product details of the wish list item. *(Deprecated: Product information is part of a composable Catalog Service.)* | +| `quantity` - [`Float!`](#float) | The quantity of this wish list item. | + +#### Example + +```json +{ + "added_at": "abc123", + "customizable_options": [SelectedCustomizableOption], + "description": "abc123", + "id": "4", + "product": ProductInterface, + "quantity": 987.65 +} +``` + + + +### SmartButtonMethodInput + +Smart button payment inputs + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `payment_source` - [`String`](#string) | The payment source for the payment method | +| `payments_order_id` - [`String`](#string) | The payment services order ID | +| `paypal_order_id` - [`String`](#string) | PayPal order ID | + +#### Example + +```json +{ + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" +} +``` + + + +### SmartButtonsConfig + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `app_switch_when_available` - [`Boolean`](#boolean) | Indicated whether to use App Switch on enabled mobile devices | +| `button_styles` - [`ButtonStyles`](#buttonstyles) | The styles for the PayPal Smart Button configuration | +| `code` - [`String`](#string) | The payment method code as defined in the payment gateway | +| `display_message` - [`Boolean`](#boolean) | Indicates whether to display the PayPal Pay Later message | +| `display_venmo` - [`Boolean`](#boolean) | Indicates whether to display Venmo | +| `is_visible` - [`Boolean`](#boolean) | Indicates whether the payment method is displayed | +| `message_styles` - [`MessageStyles`](#messagestyles) | Contains details about the styles for the PayPal Pay Later message | +| `payment_intent` - [`String`](#string) | Defines the payment intent (Authorize or Capture | +| `sdk_params` - [`[SDKParams]`](#sdkparams) | The PayPal parameters required to load the JS SDK | +| `sort_order` - [`String`](#string) | The relative order the payment method is displayed on the checkout page | +| `title` - [`String`](#string) | The name displayed for the payment method | + +#### Example + +```json +{ + "app_switch_when_available": true, + "button_styles": ButtonStyles, + "code": "abc123", + "display_message": false, + "display_venmo": false, + "is_visible": false, + "message_styles": MessageStyles, + "payment_intent": "abc123", + "sdk_params": [SDKParams], + "sort_order": "abc123", + "title": "abc123" +} +``` + + + +### SortEnum + +Indicates whether to return results in ascending or descending order. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `ASC` | | +| `DESC` | | + +#### Example + +```json +""ASC"" +``` + + + +### SortField + +Defines a possible sort field. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `label` - [`String`](#string) | The label of the sort field. | +| `value` - [`String`](#string) | The attribute code of the sort field. | + +#### Example + +```json +{ + "label": "abc123", + "value": "abc123" +} +``` + + + +### SortFields + +Contains a default value for sort fields and all available sort fields. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `default` - [`String`](#string) | The default sort field value. | +| `options` - [`[SortField]`](#sortfield) | An array of possible sort fields. | + +#### Example + +```json +{ + "default": "xyz789", + "options": [SortField] +} +``` + + + +### SortQuoteItemsEnum + +Specifies the field to use for sorting quote items + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `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 + +```json +""ITEM_ID"" +``` + + + +### SortableAttribute + +Contains product attributes that be used for sorting in a `productSearch` query + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `attribute` - [`String!`](#string) | The unique identifier for an attribute code. This value should be in lowercase letters and without space | +| `frontendInput` - [`String`](#string) | Indicates how field rendered on storefront | +| `label` - [`String`](#string) | The display name assigned to the attribute | +| `numeric` - [`Boolean`](#boolean) | Indicates whether this attribute has a numeric value, such as a price or integer | + +#### Example + +```json +{ + "attribute": "abc123", + "frontendInput": "xyz789", + "label": "abc123", + "numeric": false +} +``` + + + +### StatsBucket + +For retrieving statistics across multiple buckets + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `max` - [`Float!`](#float) | The maximum value | +| `min` - [`Float!`](#float) | The minimum value | +| `title` - [`String!`](#string) | The display text for the bucket | + +#### Example + +```json +{ + "max": 987.65, + "min": 123.45, + "title": "abc123" +} +``` + + + +### StoreConfig + +Contains information about a store's configuration. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `allow_company_registration` - [`Boolean!`](#boolean) | Indicates if company registration is allowed | +| `allow_gift_receipt` - [`String`](#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`](#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`](#string) | Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No). | +| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | +| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | +| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | +| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | +| `base_currency_code` - [`String`](#string) | The base currency code. | +| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | +| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | +| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | +| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | +| `cart_expires_in_days` - [`Int`](#int) | checkout/cart/delete_quote_after: quote lifetime in days. | +| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | +| `cart_merge_preference` - [`String!`](#string) | Configuration data from checkout/cart/cart_merge_preference | +| `cart_printed_card` - [`String`](#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`](#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`](#string) | The default sort order of the search results list. | +| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | +| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | +| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | +| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | +| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | +| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | +| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | +| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | +| `company_credit_enabled` - [`Boolean!`](#boolean) | Indicates if company credit is enabled. | +| `company_enabled` - [`Boolean!`](#boolean) | Indicates if B2B company functionality is enabled | +| `configurable_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | +| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | +| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | +| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | +| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | +| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | +| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | +| `default_display_currency_code` - [`String`](#string) | The default display currency code. | +| `display_product_prices_in_catalog` - [`Int!`](#int) | Configuration data from tax/display/type | +| `display_shipping_prices` - [`Int!`](#int) | Configuration data from tax/display/shipping | +| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | +| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | +| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](#boolean) | Configuration data from tax/weee/apply_vat | +| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](#int) | Configuration data from tax/weee/display_email | +| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](#int) | Configuration data from tax/weee/display_list | +| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](#int) | Configuration data from tax/weee/display_sales | +| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](#int) | Configuration data from tax/weee/display | +| `fixed_product_taxes_enable` - [`Boolean!`](#boolean) | Configuration data from tax/weee/enable | +| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](#boolean) | Configuration data from tax/weee/include_in_subtotal | +| `graphql_share_customer_group` - [`Boolean!`](#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | +| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | +| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | +| `grouped_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | +| `is_checkout_agreements_enabled` - [`Boolean!`](#boolean) | Configuration data from checkout/options/enable_agreements | +| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | +| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | +| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | +| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | +| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | +| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | +| `list_mode` - [`String`](#string) | The format of the search results list. | +| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | +| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | +| `locale` - [`String`](#string) | The store locale. | +| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | +| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | +| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | +| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | +| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | +| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | +| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | +| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | +| `max_items_in_order_summary` - [`Int`](#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | +| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | +| `minicart_display` - [`Boolean`](#boolean) | checkout/sidebar/display: whether to display the minicart or not. | +| `minicart_max_items` - [`Int`](#int) | checkout/sidebar/count: maximum number of items to show in minicart. | +| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | +| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | +| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | +| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | +| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | +| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/full_summary | +| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/grandtotal | +| `orders_invoices_credit_memos_display_price` - [`Int!`](#int) | Configuration data from tax/sales_display/price | +| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](#int) | Configuration data from tax/sales_display/shipping | +| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](#int) | Configuration data from tax/sales_display/subtotal | +| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/zero_tax | +| `printed_card_priceV2` - [`Money`](#money) | The default price of a printed card that accompanies an order. | +| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | +| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | +| `quote_minimum_amount` - [`Float`](#float) | Minimum order total for quote request. | +| `quote_minimum_amount_message` - [`String`](#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`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | +| `requisition_list_share_link_validity_days` - [`Int!`](#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | +| `requisition_list_share_max_recipients` - [`Int!`](#int) | Configuration data from btob/requisition_list_sharing/max_recipients | +| `requisition_list_share_storefront_path` - [`String!`](#string) | Configuration data from btob/requisition_list_sharing/storefront_share_path (route path for share links, no leading or trailing slashes) | +| `requisition_list_sharing_enabled` - [`Boolean!`](#boolean) | Configuration data from btob/requisition_list_sharing/enabled | +| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | +| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | +| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | +| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | +| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | +| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | +| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | +| `share_active_segments` - [`Boolean!`](#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | +| `share_applied_cart_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | +| `shopping_assistance_checkbox_title` - [`String`](#string) | Configuration data from login_as_customer/general/shopping_assistance_checkbox_title | +| `shopping_assistance_checkbox_tooltip` - [`String`](#string) | Configuration data from login_as_customer/general/shopping_assistance_checkbox_tooltip | +| `shopping_assistance_enabled` - [`Boolean!`](#boolean) | Configuration data from login_as_customer/general/enabled | +| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | +| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | +| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | +| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | +| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | +| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | +| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | +| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | +| `store_group_name` - [`String`](#string) | The label assigned to the store group. | +| `store_name` - [`String`](#string) | The label assigned to the store view. | +| `store_sort_order` - [`Int`](#int) | The store view sort order. | +| `timezone` - [`String`](#string) | The time zone of the store. | +| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | +| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | +| `website_code` - [`ID`](#id) | The unique ID for the website. | +| `website_name` - [`String`](#string) | The label assigned to the website. | +| `weight_unit` - [`String`](#string) | The unit of weight. | +| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | +| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | +| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | +| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | +| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | + +#### Example + +```json +{ + "allow_company_registration": true, + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "abc123", + "allow_items": "abc123", + "allow_order": "abc123", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": true, + "base_currency_code": "abc123", + "base_link_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "xyz789", + "base_url": "abc123", + "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", + "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": 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": "xyz789", + "check_money_order_send_check_to": "xyz789", + "check_money_order_sort_order": 987, + "check_money_order_title": "abc123", + "company_credit_enabled": true, + "company_enabled": true, + "configurable_product_image": "ITSELF", + "configurable_thumbnail_source": "abc123", + "contact_enabled": true, + "countries_with_required_region": "xyz789", + "create_account_confirmation": true, + "customer_access_token_lifetime": 123.45, + "default_country": "abc123", + "default_display_currency_code": "abc123", + "display_product_prices_in_catalog": 123, + "display_shipping_prices": 987, + "display_state_if_optional": false, + "enable_multiple_wishlists": "xyz789", + "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, + "graphql_share_customer_group": true, + "grid_per_page": 987, + "grid_per_page_values": "abc123", + "grouped_product_image": "ITSELF", + "is_checkout_agreements_enabled": false, + "is_default_store": true, + "is_default_store_group": true, + "is_guest_checkout_enabled": true, + "is_negotiable_quote_active": false, + "is_one_page_checkout_enabled": false, + "is_requisition_list_active": "xyz789", + "list_mode": "xyz789", + "list_per_page": 987, + "list_per_page_values": "xyz789", + "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": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", + "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", + "magento_reward_points_newsletter": "abc123", + "magento_reward_points_order": "abc123", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "abc123", + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, + "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": 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, + "quote_minimum_amount": 987.65, + "quote_minimum_amount_message": "abc123", + "required_character_classes_number": "abc123", + "requisition_list_share_link_validity_days": 123, + "requisition_list_share_max_recipients": 987, + "requisition_list_share_storefront_path": "xyz789", + "requisition_list_sharing_enabled": false, + "returns_enabled": "xyz789", + "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": "abc123", + "secure_base_media_url": "xyz789", + "secure_base_static_url": "xyz789", + "secure_base_url": "xyz789", + "share_active_segments": false, + "share_applied_cart_rule": true, + "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_enabled": false, + "shopping_cart_display_full_summary": false, + "shopping_cart_display_grand_total": false, + "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, + "store_code": 4, + "store_group_code": 4, + "store_group_name": "abc123", + "store_name": "xyz789", + "store_sort_order": 123, + "timezone": "abc123", + "title_separator": "abc123", + "use_store_in_url": false, + "website_code": 4, + "website_name": "abc123", + "weight_unit": "xyz789", + "zero_subtotal_enable_for_specific_countries": false, + "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": "xyz789" +} +``` + + + +### String + +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 + +```json +"abc123" +``` + + + +### StringOperatorInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `type` - [`StringOperatorType`](#stringoperatortype) | | + +#### Example + +```json +{"type": "UNKNOWN_STRING_OPERATOR"} +``` + + + +### StringOperatorType + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `UNKNOWN_STRING_OPERATOR` | | +| `SAME_AS_CURRENT` | | +| `ALL_EXCEPT_CURRENT` | | + +#### Example + +```json +""UNKNOWN_STRING_OPERATOR"" +``` + + + +### SubmitNegotiableQuoteTemplateForReviewInput + +Specifies the quote template properties to update. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote template comment file attachments. | +| `comment` - [`String`](#string) | A comment for the seller to review. | +| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | +| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | +| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | +| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | + +#### Example + +```json +{ + "attachments": [NegotiableQuoteCommentAttachmentInput], + "comment": "xyz789", + "max_order_commitment": 123, + "min_order_commitment": 987, + "name": "xyz789", + "reference_document_links": [ + NegotiableQuoteTemplateReferenceDocumentLinkInput + ], + "template_id": 4 +} +``` + + + +### SubscribeEmailToNewsletterOutput + +Contains the result of the `subscribeEmailToNewsletter` operation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | + +#### Example + +```json +{"status": "NOT_ACTIVE"} +``` + + + +### SubscriptionStatusesEnum + +Indicates the status of the request. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_ACTIVE` | | +| `SUBSCRIBED` | | +| `UNSUBSCRIBED` | | +| `UNCONFIRMED` | | + +#### Example + +```json +""NOT_ACTIVE"" +``` + + + +### Subtree + +Represents the subtree of the categories to retrieve. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `depth` - [`Int!`](#int) | The depth of the subcategories to retrieve. For example, a value of `2` returns two levels of subcategories beneath the value specified in `startLevel`. | +| `startLevel` - [`Int!`](#int) | The level of the category tree to use as the starting point of the query. For example, `1` indicates the topmost category is the starting point. | + +#### Example + +```json +{"depth": 123, "startLevel": 123} +``` + + + +### SwatchDataInterface + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | + +#### Possible Types + +| SwatchDataInterface Types | +|----------------| +| [`ColorSwatchData`](#colorswatchdata) | +| [`ImageSwatchData`](#imageswatchdata) | +| [`TextSwatchData`](#textswatchdata) | + +#### Example + +```json +{"value": "xyz789"} +``` + + + +### SwatchInputTypeEnum + +Swatch attribute metadata input types. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `BOOLEAN` | | +| `DATE` | | +| `DATETIME` | | +| `DROPDOWN` | | +| `FILE` | | +| `GALLERY` | | +| `HIDDEN` | | +| `IMAGE` | | +| `MEDIA_IMAGE` | | +| `MULTILINE` | | +| `MULTISELECT` | | +| `PRICE` | | +| `SELECT` | | +| `TEXT` | | +| `TEXTAREA` | | +| `UNDEFINED` | | +| `VISUAL` | | +| `WEIGHT` | | + +#### Example + +```json +""BOOLEAN"" +``` + + + +### SwatchType + +The type of the swatch. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `TEXT` | | +| `IMAGE` | | +| `COLOR_HEX` | | +| `CUSTOM` | | + +#### Example + +```json +""TEXT"" +``` + + + +### SyncPaymentOrderInput + +Synchronizes the payment order details + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cartId` - [`String!`](#string) | The customer cart ID | +| `id` - [`String!`](#string) | PayPal order ID | + +#### Example + +```json +{ + "cartId": "xyz789", + "id": "abc123" +} +``` + + diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-4.md b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md similarity index 53% rename from src/pages/includes/autogenerated/graphql-api-saas-types-4.md rename to src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md index b438fb97d..1c1261bcb 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-4.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md @@ -1,552 +1,4 @@ -### StoreConfig - -Contains information about a store's configuration. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `allow_company_registration` - [`Boolean!`](#boolean) | Indicates if company registration is allowed | -| `allow_gift_receipt` - [`String`](#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`](#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`](#string) | Indicates whether gift wrapping can be added for individual order items. Possible values: 1 (Yes) and 0 (No). | -| `allow_items` - [`String`](#string) | The value of the Allow Gift Messages for Order Items option | -| `allow_order` - [`String`](#string) | The value of the Allow Gift Messages on Order Level option | -| `allow_printed_card` - [`String`](#string) | Indicates if a printed card can accompany an order. Possible values: 1 (Yes) and 0 (No). | -| `autocomplete_on_storefront` - [`Boolean`](#boolean) | Indicates whether to enable autocomplete on login and forgot password forms. | -| `base_currency_code` - [`String`](#string) | The base currency code. | -| `base_link_url` - [`String`](#string) | A fully-qualified URL that is used to create relative links to the `base_url`. | -| `base_media_url` - [`String`](#string) | The fully-qualified URL that specifies the location of media files. | -| `base_static_url` - [`String`](#string) | The fully-qualified URL that specifies the location of static view files. | -| `base_url` - [`String`](#string) | The store’s fully-qualified base URL. | -| `cart_expires_in_days` - [`Int`](#int) | checkout/cart/delete_quote_after: quote lifetime in days. | -| `cart_gift_wrapping` - [`String`](#string) | Indicates if gift wrapping prices are displayed on the Shopping Cart page. Possible values: 1 (Yes) and 0 (No). | -| `cart_merge_preference` - [`String!`](#string) | Configuration data from checkout/cart/cart_merge_preference | -| `cart_printed_card` - [`String`](#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`](#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`](#string) | The default sort order of the search results list. | -| `category_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | The suffix applied to category pages, such as `.htm` or `.html`. | -| `check_money_order_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `check_money_order_enabled` - [`Boolean`](#boolean) | Indicates whether the Check/Money Order payment method is enabled. | -| `check_money_order_make_check_payable_to` - [`String`](#string) | The name of the party to whom the check must be payable. | -| `check_money_order_max_order_total` - [`String`](#string) | The maximum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_min_order_total` - [`String`](#string) | The minimum order amount required to qualify for the Check/Money Order payment method. | -| `check_money_order_new_order_status` - [`String`](#string) | The status of new orders placed using the Check/Money Order payment method. | -| `check_money_order_payment_from_specific_countries` - [`String`](#string) | A comma-separated list of specific countries allowed to use the Check/Money Order payment method. | -| `check_money_order_send_check_to` - [`String`](#string) | The full street address or PO Box where the checks are mailed. | -| `check_money_order_sort_order` - [`Int`](#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`](#string) | The title of the Check/Money Order payment method displayed on the storefront. | -| `company_credit_enabled` - [`Boolean!`](#boolean) | Indicates if company credit is enabled. | -| `company_enabled` - [`Boolean!`](#boolean) | Indicates if B2B company functionality is enabled | -| `configurable_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/configurable_product_image: which image to use for configurable products. | -| `configurable_thumbnail_source` - [`String`](#string) | Indicates whether the `parent` or child (`itself`) thumbnail should be used in the cart for configurable products. | -| `contact_enabled` - [`Boolean!`](#boolean) | Indicates whether the Contact Us form in enabled. | -| `countries_with_required_region` - [`String`](#string) | Extended Config Data - general/region/state_required | -| `create_account_confirmation` - [`Boolean`](#boolean) | Indicates if the new accounts need confirmation. | -| `customer_access_token_lifetime` - [`Float`](#float) | Customer access token lifetime. | -| `default_country` - [`String`](#string) | Extended Config Data - general/country/default | -| `default_display_currency_code` - [`String`](#string) | The default display currency code. | -| `display_product_prices_in_catalog` - [`Int!`](#int) | Configuration data from tax/display/type | -| `display_shipping_prices` - [`Int!`](#int) | Configuration data from tax/display/shipping | -| `display_state_if_optional` - [`Boolean`](#boolean) | Extended Config Data - general/region/display_all | -| `enable_multiple_wishlists` - [`String`](#string) | Indicates whether customers can have multiple wish lists. Possible values: 1 (Yes) and 0 (No). | -| `fixed_product_taxes_apply_tax_to_fpt` - [`Boolean!`](#boolean) | Configuration data from tax/weee/apply_vat | -| `fixed_product_taxes_display_prices_in_emails` - [`Int!`](#int) | Configuration data from tax/weee/display_email | -| `fixed_product_taxes_display_prices_in_product_lists` - [`Int!`](#int) | Configuration data from tax/weee/display_list | -| `fixed_product_taxes_display_prices_in_sales_modules` - [`Int!`](#int) | Configuration data from tax/weee/display_sales | -| `fixed_product_taxes_display_prices_on_product_view_page` - [`Int!`](#int) | Configuration data from tax/weee/display | -| `fixed_product_taxes_enable` - [`Boolean!`](#boolean) | Configuration data from tax/weee/enable | -| `fixed_product_taxes_include_fpt_in_subtotal` - [`Boolean!`](#boolean) | Configuration data from tax/weee/include_in_subtotal | -| `graphql_share_customer_group` - [`Boolean!`](#boolean) | Configuration data from customer/account_information/graphql_share_customer_group | -| `grid_per_page` - [`Int`](#int) | The default number of products per page in Grid View. | -| `grid_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in Grid View. | -| `grouped_product_image` - [`ProductImageThumbnail!`](#productimagethumbnail) | checkout/cart/grouped_product_image: which image to use for grouped products. | -| `is_checkout_agreements_enabled` - [`Boolean!`](#boolean) | Configuration data from checkout/options/enable_agreements | -| `is_default_store` - [`Boolean`](#boolean) | Indicates whether the store view has been designated as the default within the store group. | -| `is_default_store_group` - [`Boolean`](#boolean) | Indicates whether the store group has been designated as the default within the website. | -| `is_guest_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/guest_checkout: whether the guest checkout is enabled or not. | -| `is_negotiable_quote_active` - [`Boolean`](#boolean) | Indicates whether negotiable quote functionality is enabled. | -| `is_one_page_checkout_enabled` - [`Boolean`](#boolean) | checkout/options/onepage_checkout_enabled: whether the one page checkout is enabled or not | -| `is_requisition_list_active` - [`String`](#string) | Indicates whether requisition lists are enabled. Possible values: 1 (Yes) and 0 (No). | -| `list_mode` - [`String`](#string) | The format of the search results list. | -| `list_per_page` - [`Int`](#int) | The default number of products per page in List View. | -| `list_per_page_values` - [`String`](#string) | A list of numbers that define how many products can be displayed in List View. | -| `locale` - [`String`](#string) | The store locale. | -| `magento_reward_general_is_enabled` - [`String`](#string) | Indicates whether reward points functionality is enabled. Possible values: 1 (Enabled) and 0 (Disabled). | -| `magento_reward_general_is_enabled_on_front` - [`String`](#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`](#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`](#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`](#string) | The number of points for a referral when an invitee registers on the site. | -| `magento_reward_points_invitation_customer_limit` - [`String`](#string) | The maximum number of registration referrals that will qualify for rewards. A null value indicates no limit. | -| `magento_reward_points_invitation_order` - [`String`](#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`](#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`](#string) | The number of points earned by registered customers who subscribe to a newsletter. | -| `magento_reward_points_order` - [`String`](#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`](#string) | The number of points customer gets for registering. | -| `magento_reward_points_review` - [`String`](#string) | The number of points for writing a review. | -| `magento_reward_points_review_limit` - [`String`](#string) | The maximum number of reviews that will qualify for the rewards. A null value indicates no limit. | -| `magento_wishlist_general_is_enabled` - [`String`](#string) | Indicates whether wishlists are enabled (1) or disabled (0). | -| `max_items_in_order_summary` - [`Int`](#int) | checkout/options/max_items_display_count: maximum number of items to display in order summary. | -| `maximum_number_of_wishlists` - [`String`](#string) | If multiple wish lists are enabled, the maximum number of wish lists the customer can have. | -| `minicart_display` - [`Boolean`](#boolean) | checkout/sidebar/display: whether to display the minicart or not. | -| `minicart_max_items` - [`Int`](#int) | checkout/sidebar/count: maximum number of items to show in minicart. | -| `minimum_password_length` - [`String`](#string) | The minimum number of characters required for a valid password. | -| `newsletter_enabled` - [`Boolean!`](#boolean) | Indicates whether newsletters are enabled. | -| `optional_zip_countries` - [`String`](#string) | Extended Config Data - general/country/optional_zip_countries | -| `order_cancellation_enabled` - [`Boolean!`](#boolean) | Indicates whether orders can be cancelled by customers or not. | -| `order_cancellation_reasons` - [`[CancellationReason]!`](#cancellationreason) | An array containing available cancellation reasons. | -| `orders_invoices_credit_memos_display_full_summary` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/full_summary | -| `orders_invoices_credit_memos_display_grandtotal` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/grandtotal | -| `orders_invoices_credit_memos_display_price` - [`Int!`](#int) | Configuration data from tax/sales_display/price | -| `orders_invoices_credit_memos_display_shipping_amount` - [`Int!`](#int) | Configuration data from tax/sales_display/shipping | -| `orders_invoices_credit_memos_display_subtotal` - [`Int!`](#int) | Configuration data from tax/sales_display/subtotal | -| `orders_invoices_credit_memos_display_zero_tax` - [`Boolean!`](#boolean) | Configuration data from tax/sales_display/zero_tax | -| `printed_card_priceV2` - [`Money`](#money) | The default price of a printed card that accompanies an order. | -| `product_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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_url_suffix` - [`String`](#string) | The suffix applied to product pages, such as `.htm` or `.html`. | -| `quickorder_active` - [`Boolean!`](#boolean) | Indicates whether quick order functionality is enabled. | -| `quote_minimum_amount` - [`Float`](#float) | Minimum order total for quote request. | -| `quote_minimum_amount_message` - [`String`](#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`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | -| `requisition_list_share_link_validity_days` - [`Int!`](#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | -| `requisition_list_share_max_recipients` - [`Int!`](#int) | Configuration data from btob/requisition_list_sharing/max_recipients | -| `requisition_list_share_storefront_path` - [`String!`](#string) | Configuration data from btob/requisition_list_sharing/storefront_share_path (route path for share links, no leading or trailing slashes) | -| `requisition_list_sharing_enabled` - [`Boolean!`](#boolean) | Configuration data from btob/requisition_list_sharing/enabled | -| `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | -| `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | -| `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#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`](#string) | Indicates if gift wrapping prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `sales_printed_card` - [`String`](#string) | Indicates if printed card prices are displayed on the Orders page. Possible values: 1 (Yes) and 0 (No). | -| `secure_base_link_url` - [`String`](#string) | A secure fully-qualified URL that is used to create relative links to the `base_url`. | -| `secure_base_media_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of media files. | -| `secure_base_static_url` - [`String`](#string) | The secure fully-qualified URL that specifies the location of static view files. | -| `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | -| `share_active_segments` - [`Boolean!`](#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | -| `share_applied_cart_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | -| `shopping_assistance_checkbox_title` - [`String`](#string) | Configuration data from login_as_customer/general/shopping_assistance_checkbox_title | -| `shopping_assistance_checkbox_tooltip` - [`String`](#string) | Configuration data from login_as_customer/general/shopping_assistance_checkbox_tooltip | -| `shopping_assistance_enabled` - [`Boolean!`](#boolean) | Configuration data from login_as_customer/general/enabled | -| `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | -| `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | -| `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | -| `shopping_cart_display_shipping` - [`Int`](#int) | Extended Config Data - tax/cart_display/shipping | -| `shopping_cart_display_subtotal` - [`Int`](#int) | Extended Config Data - tax/cart_display/subtotal | -| `shopping_cart_display_tax_gift_wrapping` - [`TaxWrappingEnum`](#taxwrappingenum) | Extended Config Data - tax/cart_display/gift_wrapping | -| `shopping_cart_display_zero_tax` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/zero_tax | -| `store_code` - [`ID`](#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`](#id) | The unique ID assigned to the store group. In the Admin, this is called the Store Name. | -| `store_group_name` - [`String`](#string) | The label assigned to the store group. | -| `store_name` - [`String`](#string) | The label assigned to the store view. | -| `store_sort_order` - [`Int`](#int) | The store view sort order. | -| `timezone` - [`String`](#string) | The time zone of the store. | -| `title_separator` - [`String`](#string) | The character that separates the category name and subcategory in the browser title bar. | -| `use_store_in_url` - [`Boolean`](#boolean) | Indicates whether the store code should be used in the URL. | -| `website_code` - [`ID`](#id) | The unique ID for the website. | -| `website_name` - [`String`](#string) | The label assigned to the website. | -| `weight_unit` - [`String`](#string) | The unit of weight. | -| `zero_subtotal_enable_for_specific_countries` - [`Boolean`](#boolean) | Indicates whether only specific countries can use this payment method. | -| `zero_subtotal_enabled` - [`Boolean`](#boolean) | Indicates whether the Zero Subtotal payment method is enabled. | -| `zero_subtotal_new_order_status` - [`String`](#string) | The status of new orders placed using the Zero Subtotal payment method. | -| `zero_subtotal_payment_action` - [`String`](#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`](#string) | A comma-separated list of specific countries allowed to use the Zero Subtotal payment method. | -| `zero_subtotal_sort_order` - [`Int`](#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`](#string) | The title of the Zero Subtotal payment method displayed on the storefront. | - -#### Example - -```json -{ - "allow_company_registration": true, - "allow_gift_receipt": "abc123", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "xyz789", - "allow_items": "abc123", - "allow_order": "xyz789", - "allow_printed_card": "xyz789", - "autocomplete_on_storefront": true, - "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "xyz789", - "base_static_url": "abc123", - "base_url": "xyz789", - "cart_expires_in_days": 987, - "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", - "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": "xyz789", - "check_money_order_enable_for_specific_countries": true, - "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": "xyz789", - "check_money_order_new_order_status": "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": "abc123", - "company_credit_enabled": true, - "company_enabled": true, - "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "abc123", - "contact_enabled": true, - "countries_with_required_region": "xyz789", - "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, - "default_country": "xyz789", - "default_display_currency_code": "xyz789", - "display_product_prices_in_catalog": 987, - "display_shipping_prices": 123, - "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", - "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": 987, - "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": false, - "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": 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": "abc123", - "list_mode": "abc123", - "list_per_page": 123, - "list_per_page_values": "xyz789", - "locale": "xyz789", - "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_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "xyz789", - "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": "xyz789", - "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "abc123", - "minicart_display": false, - "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": false, - "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": true, - "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, - "printed_card_priceV2": Money, - "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_url_suffix": "xyz789", - "quickorder_active": false, - "quote_minimum_amount": 123.45, - "quote_minimum_amount_message": "abc123", - "required_character_classes_number": "xyz789", - "requisition_list_share_link_validity_days": 123, - "requisition_list_share_max_recipients": 987, - "requisition_list_share_storefront_path": "abc123", - "requisition_list_sharing_enabled": true, - "returns_enabled": "abc123", - "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": "abc123", - "secure_base_url": "xyz789", - "share_active_segments": true, - "share_applied_cart_rule": true, - "shopping_assistance_checkbox_title": "abc123", - "shopping_assistance_checkbox_tooltip": "abc123", - "shopping_assistance_enabled": false, - "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 123, - "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, - "store_code": 4, - "store_group_code": 4, - "store_group_name": "abc123", - "store_name": "xyz789", - "store_sort_order": 123, - "timezone": "abc123", - "title_separator": "xyz789", - "use_store_in_url": false, - "website_code": 4, - "website_name": "abc123", - "weight_unit": "xyz789", - "zero_subtotal_enable_for_specific_countries": false, - "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_title": "abc123" -} -``` - - - -### String - -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 - -```json -"abc123" -``` - - - -### StringOperatorInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `type` - [`StringOperatorType`](#stringoperatortype) | | - -#### Example - -```json -{"type": "UNKNOWN_STRING_OPERATOR"} -``` - - - -### StringOperatorType - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `UNKNOWN_STRING_OPERATOR` | | -| `SAME_AS_CURRENT` | | -| `ALL_EXCEPT_CURRENT` | | - -#### Example - -```json -""UNKNOWN_STRING_OPERATOR"" -``` - - - -### SubmitNegotiableQuoteTemplateForReviewInput - -Specifies the quote template properties to update. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `attachments` - [`[NegotiableQuoteCommentAttachmentInput]`](#negotiablequotecommentattachmentinput) | Negotiable quote template comment file attachments. | -| `comment` - [`String`](#string) | A comment for the seller to review. | -| `max_order_commitment` - [`Int`](#int) | Commitment for maximum orders | -| `min_order_commitment` - [`Int`](#int) | Commitment for minimum orders | -| `name` - [`String`](#string) | The title assigned to the negotiable quote template. | -| `reference_document_links` - [`[NegotiableQuoteTemplateReferenceDocumentLinkInput]`](#negotiablequotetemplatereferencedocumentlinkinput) | An array of reference document links to add to the negotiable quote template. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | - -#### Example - -```json -{ - "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "abc123", - "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "abc123", - "reference_document_links": [ - NegotiableQuoteTemplateReferenceDocumentLinkInput - ], - "template_id": 4 -} -``` - - - -### SubscribeEmailToNewsletterOutput - -Contains the result of the `subscribeEmailToNewsletter` operation. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `status` - [`SubscriptionStatusesEnum`](#subscriptionstatusesenum) | The status of the subscription request. | - -#### Example - -```json -{"status": "NOT_ACTIVE"} -``` - - - -### SubscriptionStatusesEnum - -Indicates the status of the request. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `NOT_ACTIVE` | | -| `SUBSCRIBED` | | -| `UNSUBSCRIBED` | | -| `UNCONFIRMED` | | - -#### Example - -```json -""NOT_ACTIVE"" -``` - - - -### Subtree - -Represents the subtree of the categories to retrieve. - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `depth` - [`Int!`](#int) | The depth of the subcategories to retrieve. For example, a value of `2` returns two levels of subcategories beneath the value specified in `startLevel`. | -| `startLevel` - [`Int!`](#int) | The level of the category tree to use as the starting point of the query. For example, `1` indicates the topmost category is the starting point. | - -#### Example - -```json -{"depth": 123, "startLevel": 123} -``` - - - -### SwatchDataInterface - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `value` - [`String`](#string) | The value can be represented as color (HEX code), image link, or text. | - -#### Possible Types - -| SwatchDataInterface Types | -|----------------| -| [`ColorSwatchData`](#colorswatchdata) | -| [`ImageSwatchData`](#imageswatchdata) | -| [`TextSwatchData`](#textswatchdata) | - -#### Example - -```json -{"value": "abc123"} -``` - - - -### SwatchInputTypeEnum - -Swatch attribute metadata input types. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `BOOLEAN` | | -| `DATE` | | -| `DATETIME` | | -| `DROPDOWN` | | -| `FILE` | | -| `GALLERY` | | -| `HIDDEN` | | -| `IMAGE` | | -| `MEDIA_IMAGE` | | -| `MULTILINE` | | -| `MULTISELECT` | | -| `PRICE` | | -| `SELECT` | | -| `TEXT` | | -| `TEXTAREA` | | -| `UNDEFINED` | | -| `VISUAL` | | -| `WEIGHT` | | - -#### Example - -```json -""BOOLEAN"" -``` - - - -### SwatchType - -The type of the swatch. - -#### Values - -| Enum Value | Description | -|------------|-------------| -| `TEXT` | | -| `IMAGE` | | -| `COLOR_HEX` | | -| `CUSTOM` | | - -#### Example - -```json -""TEXT"" -``` - - - -### SyncPaymentOrderInput - -Synchronizes the payment order details - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `cartId` - [`String!`](#string) | The customer cart ID | -| `id` - [`String!`](#string) | PayPal order ID | - -#### Example - -```json -{ - "cartId": "xyz789", - "id": "xyz789" -} -``` - - +## Types ### TaxItem @@ -663,7 +115,7 @@ Defines the input schema for unassigning a child company from its parent company #### Example ```json -{"child_company_id": "4"} +{"child_company_id": 4} ``` @@ -705,13 +157,13 @@ Contains the response to the request to unassign a child company. ```json { - "unitName": "abc123", - "storefrontLabel": "abc123", + "unitName": "xyz789", + "storefrontLabel": "xyz789", "pagePlacement": "xyz789", "displayNumber": 123, - "pageType": "abc123", - "unitStatus": "xyz789", - "typeId": "abc123", + "pageType": "xyz789", + "unitStatus": "abc123", + "typeId": "xyz789", "filterRules": [FilterRuleInput] } ``` @@ -733,7 +185,7 @@ Modifies the specified items in the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [CartItemUpdateInput] } ``` @@ -874,8 +326,8 @@ Defines updates to a `GiftRegistry` object. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", - "message": "xyz789", + "event_name": "abc123", + "message": "abc123", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, "status": "ACTIVE" @@ -966,9 +418,9 @@ Defines updates to an existing registrant. GiftRegistryDynamicAttributeInput ], "email": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "gift_registry_registrant_uid": 4, - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -1120,7 +572,7 @@ Defines the changes to be made to an approval rule. "description": "abc123", "name": "abc123", "status": "ENABLED", - "uid": "4" + "uid": 4 } ``` @@ -1141,7 +593,7 @@ An input object that defines which requistion list characteristics to update. ```json { - "description": "abc123", + "description": "xyz789", "name": "abc123" } ``` @@ -1167,8 +619,8 @@ Defines which items in a requisition list to update. { "entered_options": [EnteredOptionInput], "item_id": 4, - "quantity": 987.65, - "selected_options": ["abc123"] + "quantity": 123.45, + "selected_options": ["xyz789"] } ``` @@ -1250,8 +702,8 @@ Defines the input for returning matching companies the customer is assigned to. ```json { - "currentPage": 987, - "pageSize": 123, + "currentPage": 123, + "pageSize": 987, "sort": [CompaniesSortInput] } ``` @@ -1332,7 +784,7 @@ Defines the purchase orders to be validated. #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -1439,7 +891,7 @@ Retrieves the vault configuration ```json { - "is_vault_enabled": false, + "is_vault_enabled": true, "sdk_params": [SDKParams], "three_ds_mode": "OFF" } @@ -1464,9 +916,9 @@ Vault payment inputs ```json { - "payment_source": "xyz789", - "payments_order_id": "abc123", - "paypal_order_id": "abc123", + "payment_source": "abc123", + "payments_order_id": "xyz789", + "paypal_order_id": "xyz789", "public_hash": "xyz789" } ``` @@ -1564,7 +1016,7 @@ An implementation for virtual product cart items. ```json { - "backorder_message": "xyz789", + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], @@ -1572,13 +1024,13 @@ An implementation for virtual product cart items. "is_available": false, "is_salable": true, "max_qty": 987.65, - "min_qty": 987.65, - "not_available_message": "xyz789", + "min_qty": 123.45, + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -1638,9 +1090,9 @@ Defines a virtual product, which is a non-tangible product that does not require ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -1648,17 +1100,17 @@ Defines a virtual product, which is a non-tangible product that does not require "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", - "manufacturer": 987, + "is_returnable": "abc123", + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", "meta_keyword": "abc123", "meta_title": "xyz789", - "min_sale_qty": 123.45, + "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": "xyz789", @@ -1668,16 +1120,16 @@ Defines a virtual product, which is a non-tangible product that does not require "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": "abc123", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123" + "url_key": "xyz789" } ``` @@ -1705,7 +1157,7 @@ Contains details about virtual products added to a requisition list. "product": ProductInterface, "quantity": 123.45, "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1730,7 +1182,7 @@ Contains a virtual product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "id": "4", @@ -1757,7 +1209,7 @@ An error encountered while performing operations with WishList. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -1802,12 +1254,12 @@ Contains a customer wish list. ```json { - "id": 4, + "id": "4", "items_count": 123, "items_v2": WishlistItems, - "name": "abc123", + "name": "xyz789", "sharing_code": "xyz789", - "updated_at": "xyz789", + "updated_at": "abc123", "visibility": "PUBLIC" } ``` @@ -1832,9 +1284,9 @@ Contains details about errors encountered when a customer added wish list items ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", - "wishlistId": 4, - "wishlistItemId": "4" + "message": "xyz789", + "wishlistId": "4", + "wishlistItemId": 4 } ``` @@ -1876,10 +1328,7 @@ Specifies the IDs of items to copy and their quantities. #### Example ```json -{ - "quantity": 123.45, - "wishlist_item_id": "4" -} +{"quantity": 987.65, "wishlist_item_id": 4} ``` @@ -1904,8 +1353,8 @@ Defines the items to add to a wish list. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["4"], + "quantity": 987.65, + "selected_options": [4], "sku": "xyz789" } ``` @@ -1946,7 +1395,7 @@ The interface for wish list items. "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": 4, + "id": "4", "product": ProductInterface, "quantity": 123.45 } @@ -1968,7 +1417,10 @@ Specifies the IDs of the items to move and their quantities. #### Example ```json -{"quantity": 123.45, "wishlist_item_id": 4} +{ + "quantity": 987.65, + "wishlist_item_id": "4" +} ``` @@ -1994,7 +1446,7 @@ Defines updates to items in a wish list. "description": "xyz789", "entered_options": [EnteredOptionInput], "quantity": 123.45, - "selected_options": [4], + "selected_options": ["4"], "wishlist_item_id": 4 } ``` @@ -2041,85 +1493,3 @@ Defines the wish list visibility types. ``` - -### finishUploadInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `key` - [`String!`](#string) | The unique key identifier from the upload | -| `media_resource_type` - [`MediaResourceType!`](#mediaresourcetype) | The type of media resource being uploaded | - -#### Example - -```json -{ - "key": "xyz789", - "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" -} -``` - - - -### finishUploadOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `key` - [`String!`](#string) | The unique key identifier | -| `message` - [`String`](#string) | Additional information about the confirmation | -| `success` - [`Boolean!`](#boolean) | Whether the confirmation was successful | - -#### Example - -```json -{ - "key": "xyz789", - "message": "xyz789", - "success": true -} -``` - - - -### initiateUploadInput - -#### Input Fields - -| Input Field | Description | -|-------------|-------------| -| `key` - [`String!`](#string) | The name of the file to be uploaded, cannot contain slashes | -| `media_resource_type` - [`MediaResourceType!`](#mediaresourcetype) | The type of media resource being uploaded | - -#### Example - -```json -{ - "key": "abc123", - "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" -} -``` - - - -### initiateUploadOutput - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `expires_at` - [`String!`](#string) | The expiration timestamp of the URL | -| `key` - [`String!`](#string) | The unique key identifier for the upload | -| `upload_url` - [`String!`](#string) | The presigned URL for uploading the file | - -#### Example - -```json -{ - "expires_at": "abc123", - "key": "abc123", - "upload_url": "abc123" -} -``` diff --git a/src/pages/reference/graphql/2-4-6/index.md b/src/pages/reference/graphql/2-4-6/index.md index f93d38892..3917b4799 100644 --- a/src/pages/reference/graphql/2-4-6/index.md +++ b/src/pages/reference/graphql/2-4-6/index.md @@ -1,6 +1,6 @@ --- -title: GraphQL API reference (2.4.6) -description: Review comprehensive reference documentation for older Adobe Commerce GraphQL API schemas. +title: "GraphQL API reference (2.4.6)" +description: "Review GraphQL queries in the Adobe Commerce 2.4.6 API schema." keywords: - GraphQL --- @@ -8,11 +8,3 @@ keywords: # Adobe Commerce GraphQL API (2.4.6) - - - - - - - - diff --git a/src/pages/reference/graphql/2-4-6/mutations.md b/src/pages/reference/graphql/2-4-6/mutations.md new file mode 100644 index 000000000..83ba29f00 --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/mutations.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Mutations" +description: "Review GraphQL mutations in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Mutations + + diff --git a/src/pages/reference/graphql/2-4-6/types-a-b.md b/src/pages/reference/graphql/2-4-6/types-a-b.md new file mode 100644 index 000000000..9c709c480 --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/types-a-b.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Types A–B" +description: "Review GraphQL types a–b in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Types A–B + + diff --git a/src/pages/reference/graphql/2-4-6/types-c-e.md b/src/pages/reference/graphql/2-4-6/types-c-e.md new file mode 100644 index 000000000..15f9912c5 --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/types-c-e.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Types C–E" +description: "Review GraphQL types c–e in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Types C–E + + diff --git a/src/pages/reference/graphql/2-4-6/types-f-i.md b/src/pages/reference/graphql/2-4-6/types-f-i.md new file mode 100644 index 000000000..dd8ba3569 --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/types-f-i.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Types F–I" +description: "Review GraphQL types f–i in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Types F–I + + diff --git a/src/pages/reference/graphql/2-4-6/types-k-p.md b/src/pages/reference/graphql/2-4-6/types-k-p.md new file mode 100644 index 000000000..abc26c9ea --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/types-k-p.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Types K–P" +description: "Review GraphQL types k–p in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Types K–P + + diff --git a/src/pages/reference/graphql/2-4-6/types-q-s.md b/src/pages/reference/graphql/2-4-6/types-q-s.md new file mode 100644 index 000000000..87d579fff --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/types-q-s.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Types Q–S" +description: "Review GraphQL types q–s in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Types Q–S + + diff --git a/src/pages/reference/graphql/2-4-6/types-t-z.md b/src/pages/reference/graphql/2-4-6/types-t-z.md new file mode 100644 index 000000000..bcc848e3f --- /dev/null +++ b/src/pages/reference/graphql/2-4-6/types-t-z.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.6) – Types T–Z" +description: "Review GraphQL types t–z in the Adobe Commerce 2.4.6 API schema." +keywords: + - GraphQL +--- + +# Types T–Z + + diff --git a/src/pages/reference/graphql/2-4-7/index.md b/src/pages/reference/graphql/2-4-7/index.md index d130223b3..3d209c7af 100644 --- a/src/pages/reference/graphql/2-4-7/index.md +++ b/src/pages/reference/graphql/2-4-7/index.md @@ -1,6 +1,6 @@ --- -title: GraphQL API reference (2.4.7) -description: Review comprehensive reference documentation for older Adobe Commerce GraphQL API schemas. +title: "GraphQL API reference (2.4.7)" +description: "Review GraphQL queries in the Adobe Commerce 2.4.7 API schema." keywords: - GraphQL --- @@ -8,13 +8,3 @@ keywords: # Adobe Commerce GraphQL API (2.4.7) - - - - - - - - - - diff --git a/src/pages/reference/graphql/2-4-7/mutations.md b/src/pages/reference/graphql/2-4-7/mutations.md new file mode 100644 index 000000000..41d36cd11 --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/mutations.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Mutations" +description: "Review GraphQL mutations in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Mutations + + diff --git a/src/pages/reference/graphql/2-4-7/types-a-b.md b/src/pages/reference/graphql/2-4-7/types-a-b.md new file mode 100644 index 000000000..19239a181 --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/types-a-b.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Types A–B" +description: "Review GraphQL types a–b in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Types A–B + + diff --git a/src/pages/reference/graphql/2-4-7/types-c-e.md b/src/pages/reference/graphql/2-4-7/types-c-e.md new file mode 100644 index 000000000..43c8ce02d --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/types-c-e.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Types C–E" +description: "Review GraphQL types c–e in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Types C–E + + diff --git a/src/pages/reference/graphql/2-4-7/types-f-i.md b/src/pages/reference/graphql/2-4-7/types-f-i.md new file mode 100644 index 000000000..14acd0822 --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/types-f-i.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Types F–I" +description: "Review GraphQL types f–i in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Types F–I + + diff --git a/src/pages/reference/graphql/2-4-7/types-k-p.md b/src/pages/reference/graphql/2-4-7/types-k-p.md new file mode 100644 index 000000000..33a4668ef --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/types-k-p.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Types K–P" +description: "Review GraphQL types k–p in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Types K–P + + diff --git a/src/pages/reference/graphql/2-4-7/types-q-s.md b/src/pages/reference/graphql/2-4-7/types-q-s.md new file mode 100644 index 000000000..6f813a592 --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/types-q-s.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Types Q–S" +description: "Review GraphQL types q–s in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Types Q–S + + diff --git a/src/pages/reference/graphql/2-4-7/types-t-z.md b/src/pages/reference/graphql/2-4-7/types-t-z.md new file mode 100644 index 000000000..248dd7a46 --- /dev/null +++ b/src/pages/reference/graphql/2-4-7/types-t-z.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.7) – Types T–Z" +description: "Review GraphQL types t–z in the Adobe Commerce 2.4.7 API schema." +keywords: + - GraphQL +--- + +# Types T–Z + + diff --git a/src/pages/reference/graphql/2-4-8/index.md b/src/pages/reference/graphql/2-4-8/index.md index 0148a31fd..cdf86f683 100644 --- a/src/pages/reference/graphql/2-4-8/index.md +++ b/src/pages/reference/graphql/2-4-8/index.md @@ -1,6 +1,6 @@ --- -title: GraphQL API reference (2.4.8) -description: Review comprehensive reference documentation for Adobe Commerce GraphQL API schemas. +title: "GraphQL API reference (2.4.8)" +description: "Review GraphQL queries in the Adobe Commerce 2.4.8 API schema." keywords: - GraphQL --- @@ -8,13 +8,3 @@ keywords: # Adobe Commerce GraphQL API (2.4.8) - - - - - - - - - - diff --git a/src/pages/reference/graphql/2-4-8/mutations.md b/src/pages/reference/graphql/2-4-8/mutations.md new file mode 100644 index 000000000..96f2620b8 --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/mutations.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Mutations" +description: "Review GraphQL mutations in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Mutations + + diff --git a/src/pages/reference/graphql/2-4-8/types-a-b.md b/src/pages/reference/graphql/2-4-8/types-a-b.md new file mode 100644 index 000000000..be898d5ad --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/types-a-b.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Types A–B" +description: "Review GraphQL types a–b in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Types A–B + + diff --git a/src/pages/reference/graphql/2-4-8/types-c-e.md b/src/pages/reference/graphql/2-4-8/types-c-e.md new file mode 100644 index 000000000..3f694ecd8 --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/types-c-e.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Types C–E" +description: "Review GraphQL types c–e in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Types C–E + + diff --git a/src/pages/reference/graphql/2-4-8/types-f-i.md b/src/pages/reference/graphql/2-4-8/types-f-i.md new file mode 100644 index 000000000..f9e07a6ae --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/types-f-i.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Types F–I" +description: "Review GraphQL types f–i in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Types F–I + + diff --git a/src/pages/reference/graphql/2-4-8/types-k-p.md b/src/pages/reference/graphql/2-4-8/types-k-p.md new file mode 100644 index 000000000..2a3c6a8f2 --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/types-k-p.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Types K–P" +description: "Review GraphQL types k–p in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Types K–P + + diff --git a/src/pages/reference/graphql/2-4-8/types-q-s.md b/src/pages/reference/graphql/2-4-8/types-q-s.md new file mode 100644 index 000000000..7ae4e0439 --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/types-q-s.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Types Q–S" +description: "Review GraphQL types q–s in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Types Q–S + + diff --git a/src/pages/reference/graphql/2-4-8/types-t-z.md b/src/pages/reference/graphql/2-4-8/types-t-z.md new file mode 100644 index 000000000..a4407cb6b --- /dev/null +++ b/src/pages/reference/graphql/2-4-8/types-t-z.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.8) – Types T–Z" +description: "Review GraphQL types t–z in the Adobe Commerce 2.4.8 API schema." +keywords: + - GraphQL +--- + +# Types T–Z + + diff --git a/src/pages/reference/graphql/index.md b/src/pages/reference/graphql/index.md deleted file mode 100644 index 98fcade27..000000000 --- a/src/pages/reference/graphql/index.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: GraphQL API reference (2.4.9) -description: Review comprehensive reference documentation for older Adobe Commerce GraphQL API schemas. -keywords: - - GraphQL ---- - -# Adobe Commerce GraphQL API - - - - - - - - - - - - diff --git a/src/pages/reference/graphql/latest/index.md b/src/pages/reference/graphql/latest/index.md new file mode 100644 index 000000000..3b867b6ca --- /dev/null +++ b/src/pages/reference/graphql/latest/index.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9)" +description: "Review GraphQL queries in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Adobe Commerce GraphQL API + + diff --git a/src/pages/reference/graphql/latest/mutations.md b/src/pages/reference/graphql/latest/mutations.md new file mode 100644 index 000000000..e4806a883 --- /dev/null +++ b/src/pages/reference/graphql/latest/mutations.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Mutations" +description: "Review GraphQL mutations in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Mutations + + diff --git a/src/pages/reference/graphql/latest/types-a-b.md b/src/pages/reference/graphql/latest/types-a-b.md new file mode 100644 index 000000000..bd8c59d6c --- /dev/null +++ b/src/pages/reference/graphql/latest/types-a-b.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Types A–B" +description: "Review GraphQL types a–b in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Types A–B + + diff --git a/src/pages/reference/graphql/latest/types-c-e.md b/src/pages/reference/graphql/latest/types-c-e.md new file mode 100644 index 000000000..ce674bec6 --- /dev/null +++ b/src/pages/reference/graphql/latest/types-c-e.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Types C–E" +description: "Review GraphQL types c–e in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Types C–E + + diff --git a/src/pages/reference/graphql/latest/types-f-i.md b/src/pages/reference/graphql/latest/types-f-i.md new file mode 100644 index 000000000..910756a9c --- /dev/null +++ b/src/pages/reference/graphql/latest/types-f-i.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Types F–I" +description: "Review GraphQL types f–i in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Types F–I + + diff --git a/src/pages/reference/graphql/latest/types-k-p.md b/src/pages/reference/graphql/latest/types-k-p.md new file mode 100644 index 000000000..bae151c28 --- /dev/null +++ b/src/pages/reference/graphql/latest/types-k-p.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Types K–P" +description: "Review GraphQL types k–p in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Types K–P + + diff --git a/src/pages/reference/graphql/latest/types-q-s.md b/src/pages/reference/graphql/latest/types-q-s.md new file mode 100644 index 000000000..e51439e25 --- /dev/null +++ b/src/pages/reference/graphql/latest/types-q-s.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Types Q–S" +description: "Review GraphQL types q–s in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Types Q–S + + diff --git a/src/pages/reference/graphql/latest/types-t-z.md b/src/pages/reference/graphql/latest/types-t-z.md new file mode 100644 index 000000000..fd1114a32 --- /dev/null +++ b/src/pages/reference/graphql/latest/types-t-z.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (2.4.9) – Types T–Z" +description: "Review GraphQL types t–z in the Adobe Commerce 2.4.9 API schema." +keywords: + - GraphQL +--- + +# Types T–Z + + diff --git a/src/pages/reference/graphql/saas/index.md b/src/pages/reference/graphql/saas/index.md index 8a979199d..d9edb3a3f 100644 --- a/src/pages/reference/graphql/saas/index.md +++ b/src/pages/reference/graphql/saas/index.md @@ -1,6 +1,6 @@ --- -title: GraphQL API reference (SaaS) -description: Review comprehensive reference documentation for Adobe Commerce as a Cloud Service GraphQL API schemas. +title: "GraphQL API reference (SaaS)" +description: "Review GraphQL queries in the Adobe Commerce as a Cloud Service API schema." keywords: - GraphQL --- @@ -8,13 +8,3 @@ keywords: # Adobe Commerce as a Cloud Service GraphQL API - - - - - - - - - - diff --git a/src/pages/reference/graphql/saas/mutations.md b/src/pages/reference/graphql/saas/mutations.md new file mode 100644 index 000000000..24f5e9be9 --- /dev/null +++ b/src/pages/reference/graphql/saas/mutations.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Mutations" +description: "Review GraphQL mutations in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Mutations + + diff --git a/src/pages/reference/graphql/saas/types-a-b.md b/src/pages/reference/graphql/saas/types-a-b.md new file mode 100644 index 000000000..ae869fd23 --- /dev/null +++ b/src/pages/reference/graphql/saas/types-a-b.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Types A–B" +description: "Review GraphQL types a–b in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Types A–B + + diff --git a/src/pages/reference/graphql/saas/types-c-e.md b/src/pages/reference/graphql/saas/types-c-e.md new file mode 100644 index 000000000..0d9170318 --- /dev/null +++ b/src/pages/reference/graphql/saas/types-c-e.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Types C–E" +description: "Review GraphQL types c–e in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Types C–E + + diff --git a/src/pages/reference/graphql/saas/types-f-i.md b/src/pages/reference/graphql/saas/types-f-i.md new file mode 100644 index 000000000..261a63d73 --- /dev/null +++ b/src/pages/reference/graphql/saas/types-f-i.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Types F–I" +description: "Review GraphQL types f–i in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Types F–I + + diff --git a/src/pages/reference/graphql/saas/types-k-p.md b/src/pages/reference/graphql/saas/types-k-p.md new file mode 100644 index 000000000..1ec299e03 --- /dev/null +++ b/src/pages/reference/graphql/saas/types-k-p.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Types K–P" +description: "Review GraphQL types k–p in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Types K–P + + diff --git a/src/pages/reference/graphql/saas/types-q-s.md b/src/pages/reference/graphql/saas/types-q-s.md new file mode 100644 index 000000000..219061357 --- /dev/null +++ b/src/pages/reference/graphql/saas/types-q-s.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Types Q–S" +description: "Review GraphQL types q–s in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Types Q–S + + diff --git a/src/pages/reference/graphql/saas/types-t-z.md b/src/pages/reference/graphql/saas/types-t-z.md new file mode 100644 index 000000000..b39681f95 --- /dev/null +++ b/src/pages/reference/graphql/saas/types-t-z.md @@ -0,0 +1,10 @@ +--- +title: "GraphQL API reference (SaaS) – Types T–Z" +description: "Review GraphQL types t–z in the Adobe Commerce as a Cloud Service API schema." +keywords: + - GraphQL +--- + +# Types T–Z + + From 20069699b57e357a18a16ac39c2ce4e5253fbe51 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Mon, 22 Jun 2026 16:35:28 -0500 Subject: [PATCH 03/10] fix: normalize SpectaQL Markdown output by sanitizing excess blank lines and trailing whitespace --- scripts/generate-spectaql-md.js | 14 +++++++++++++- .../autogenerated/graphql-api-2-4-6-types-f-i.md | 4 ++-- .../autogenerated/graphql-api-2-4-7-types-f-i.md | 4 ++-- .../autogenerated/graphql-api-2-4-8-types-f-i.md | 4 ++-- .../autogenerated/graphql-api-2-4-9-types-f-i.md | 4 ++-- 5 files changed, 21 insertions(+), 9 deletions(-) diff --git a/scripts/generate-spectaql-md.js b/scripts/generate-spectaql-md.js index a0e1e1e2f..a5a8351bb 100644 --- a/scripts/generate-spectaql-md.js +++ b/scripts/generate-spectaql-md.js @@ -28,6 +28,18 @@ const TYPE_LETTER_RANGES = [ const TYPES_HEADER = '## Types\n\n'; +// Normalize SpectaQL Markdown for markdownlint: collapse excess blank lines and +// strip trailing whitespace from each line (MD009; SpectaQL often emits single +// trailing spaces on table rows and wrapped scalar descriptions). +function sanitizeMarkdown(content) { + return content + .split('\n') + .map(line => line.replace(/[ \t]+$/, '')) + .join('\n') + .replace(/\n{3,}/g, '\n\n') + .trimEnd() + '\n'; +} + // Reads spectaql.targetDir and spectaql.targetFile from a config YAML and // returns the resolved absolute path of the output file. function outputFileFor(configRelPath) { @@ -252,7 +264,7 @@ for (const schema of toRun) { // Read the monolithic output, collapse excess blank lines, then delete it — // it will be replaced by the split chunk files below. const raw = fs.readFileSync(outputFile, 'utf8'); - const content = raw.replace(/\n{3,}/g, '\n\n').trimEnd() + '\n'; + const content = sanitizeMarkdown(raw); fs.unlinkSync(outputFile); const sections = parseSections(content); diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md index a258b2e2a..ca6370dbb 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md @@ -182,7 +182,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). #### Example @@ -1826,7 +1826,7 @@ When expected as an input type, any string (such as `"4"`) or integer ### Int The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. +values. Int can represent values between -(2^31) and 2^31 - 1. #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md index 69c6b6838..0393de268 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md @@ -200,7 +200,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). #### Example @@ -2003,7 +2003,7 @@ List of templates/filters applied to customer attribute input. ### Int The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. +values. Int can represent values between -(2^31) and 2^31 - 1. #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md index 9384bda55..82d4ccd9e 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md @@ -200,7 +200,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). #### Example @@ -2180,7 +2180,7 @@ List of templates/filters applied to customer attribute input. ### Int The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. +values. Int can represent values between -(2^31) and 2^31 - 1. #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md index 21204e170..f6e21447d 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md @@ -254,7 +254,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). #### Example @@ -2194,7 +2194,7 @@ List of templates/filters applied to customer attribute input. ### Int The `Int` scalar type represents non-fractional signed whole numeric -values. Int can represent values between -(2^31) and 2^31 - 1. +values. Int can represent values between -(2^31) and 2^31 - 1. #### Example From 09518ec704d1b32af38e06e06c53711eccb92b55 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Tue, 23 Jun 2026 10:40:37 -0500 Subject: [PATCH 04/10] fix: update IEEE 754 links in Float scalar type descriptions across multiple schema files --- spectaql/schema.json | 2 +- spectaql/schema_2-4-6.json | 2 +- spectaql/schema_2-4-7.json | 2 +- spectaql/schema_2-4-8.json | 2 +- src/pages/config.md | 2 +- src/pages/graphql/index.md | 4 ++-- .../includes/autogenerated/graphql-api-2-4-6-types-f-i.md | 2 +- .../includes/autogenerated/graphql-api-2-4-7-types-f-i.md | 2 +- .../includes/autogenerated/graphql-api-2-4-8-types-f-i.md | 2 +- .../includes/autogenerated/graphql-api-2-4-9-types-f-i.md | 2 +- 10 files changed, 11 insertions(+), 11 deletions(-) diff --git a/spectaql/schema.json b/spectaql/schema.json index b8003bcd9..8bcac91ea 100644 --- a/spectaql/schema.json +++ b/spectaql/schema.json @@ -1669,7 +1669,7 @@ { "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). ", + "description": "The `Float` scalar type represents signed double-precision fractional\nvalues as specified by\n[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). ", "fields": null, "inputFields": null, "interfaces": null, diff --git a/spectaql/schema_2-4-6.json b/spectaql/schema_2-4-6.json index 7945d624b..940536a78 100644 --- a/spectaql/schema_2-4-6.json +++ b/spectaql/schema_2-4-6.json @@ -1231,7 +1231,7 @@ { "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). ", + "description": "The `Float` scalar type represents signed double-precision fractional\nvalues as specified by\n[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). ", "fields": null, "inputFields": null, "interfaces": null, diff --git a/spectaql/schema_2-4-7.json b/spectaql/schema_2-4-7.json index f89aab0ac..62ead651b 100644 --- a/spectaql/schema_2-4-7.json +++ b/spectaql/schema_2-4-7.json @@ -1583,7 +1583,7 @@ { "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). ", + "description": "The `Float` scalar type represents signed double-precision fractional\nvalues as specified by\n[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). ", "fields": null, "inputFields": null, "interfaces": null, diff --git a/spectaql/schema_2-4-8.json b/spectaql/schema_2-4-8.json index 2afcfb97c..a9a787003 100644 --- a/spectaql/schema_2-4-8.json +++ b/spectaql/schema_2-4-8.json @@ -1622,7 +1622,7 @@ { "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). ", + "description": "The `Float` scalar type represents signed double-precision fractional\nvalues as specified by\n[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). ", "fields": null, "inputFields": null, "interfaces": null, diff --git a/src/pages/config.md b/src/pages/config.md index 087a5d552..5056d7b7f 100644 --- a/src/pages/config.md +++ b/src/pages/config.md @@ -2,7 +2,7 @@ - /commerce/webapi/ - pages: - - [Commerce](https://developer.adobe.com/commerce/docs) + - [Commerce](https://developer.adobe.com/commerce/docs/) - [Web APIs](/index.md) - [Get Started](/get-started/index.md) - REST diff --git a/src/pages/graphql/index.md b/src/pages/graphql/index.md index 36f640b4c..4d04267fe 100755 --- a/src/pages/graphql/index.md +++ b/src/pages/graphql/index.md @@ -11,9 +11,9 @@ keywords: Adobe Commerce provides two comprehensive GraphQL implementations that serve as the ideal foundation for building next-generation commerce experiences, including [headless storefronts](https://experienceleague.adobe.com/developer/commerce/storefront/get-started/) and sophisticated mobile applications. -- Adobe Commerce on Cloud and on-premises (PaaS) projects can implement the GraphQL schemas that have long been available to Adobe Commerce and Magento Open Source projects. Separate schemas are available for [core and B2B Commerce](../reference/graphql/2-4-8/index.md) functionality and service-based features, including [Catalog Service](schema/catalog-service/index.md), [Live Search](schema/live-search/index.md), and [Recommendations](schema/product-recommendations/index.md). These schemas do not natively interact, but can be integrated with [API Mesh](https://developer.adobe.com/graphql-mesh-gateway/). +- Adobe Commerce on Cloud and on-premises (PaaS) projects can implement the GraphQL schemas that have long been available to Adobe Commerce and Magento Open Source projects. Separate schemas are available for [core and B2B Commerce](../graphql/reference/2-4-8/index.md) functionality and service-based features, including [Catalog Service](schema/catalog-service/index.md), [Live Search](schema/live-search/index.md), and [Recommendations](schema/product-recommendations/index.md). These schemas do not natively interact, but can be integrated with [API Mesh](https://developer.adobe.com/graphql-mesh-gateway/). -- [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md) (SaaS) projects can connect to a supergraph that not only combines and streamlines the schemas available to PaaS projects, but provides instant access to the latest features added in the [Storefront Compatability Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/storefront-compatibility/v248/) and other sources. Therefore, SaaS projects can take advantage of the latest GraphQL features without needing to wait for a new release. +- [Adobe Commerce as a Cloud Service](/graphql/reference/saas/index.md) (SaaS) projects can connect to a supergraph that not only combines and streamlines the schemas available to PaaS projects, but provides instant access to the latest features added in the [Storefront Compatability Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/storefront-compatibility/v248/) and other sources. Therefore, SaaS projects can take advantage of the latest GraphQL features without needing to wait for a new release. diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md index ca6370dbb..34f9aa923 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-6-types-f-i.md @@ -182,7 +182,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md index 0393de268..397e4f07b 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-7-types-f-i.md @@ -200,7 +200,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md index 82d4ccd9e..c0fd77a7d 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-8-types-f-i.md @@ -200,7 +200,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). #### Example diff --git a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md index f6e21447d..1f2c8712e 100644 --- a/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-2-4-9-types-f-i.md @@ -254,7 +254,7 @@ Lists display settings for the Fixed Product Tax. The `Float` scalar type represents signed double-precision fractional values as specified by -[IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point). +[IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). #### Example From 34dfb539d580cb793ca9dc557e2fcd2fa4502e27 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Tue, 23 Jun 2026 13:11:39 -0500 Subject: [PATCH 05/10] Test the rendering fix --- .github/workflows/deploy-github-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-github-pages.yml b/.github/workflows/deploy-github-pages.yml index a1699e3ca..c5a1f9fa6 100644 --- a/.github/workflows/deploy-github-pages.yml +++ b/.github/workflows/deploy-github-pages.yml @@ -10,6 +10,6 @@ permissions: jobs: preview: - uses: AdobeDocs/commerce-contributor/.github/workflows/github-pages-preview.yml@main + uses: AdobeDocs/commerce-contributor/.github/workflows/github-pages-preview.yml@ds_COMDOX-1736 with: branch: ${{ github.ref_name }} From c7dd22eb9550e69e3172e24a71da62dd1a281ad7 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Tue, 23 Jun 2026 14:19:43 -0500 Subject: [PATCH 06/10] fix: update GitHub Actions workflow reference to use the main branch for preview job --- .github/workflows/deploy-github-pages.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy-github-pages.yml b/.github/workflows/deploy-github-pages.yml index c5a1f9fa6..a1699e3ca 100644 --- a/.github/workflows/deploy-github-pages.yml +++ b/.github/workflows/deploy-github-pages.yml @@ -10,6 +10,6 @@ permissions: jobs: preview: - uses: AdobeDocs/commerce-contributor/.github/workflows/github-pages-preview.yml@ds_COMDOX-1736 + uses: AdobeDocs/commerce-contributor/.github/workflows/github-pages-preview.yml@main with: branch: ${{ github.ref_name }} From 04a7d0527cb35e8ab090bac2b022fc8a7cf12e99 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Tue, 23 Jun 2026 14:38:47 -0500 Subject: [PATCH 07/10] fix: update GraphQL references to point to the correct paths after GraphQL docs restructuring --- src/pages/graphql/index.md | 4 ++-- .../mutations/add-products-new-cart.md | 6 +++--- .../mutations/complete-order.md | 2 +- .../mutations/create-payment-order.md | 2 +- .../create-vault-card-payment-token.md | 2 +- .../create-vault-card-setup-token.md | 2 +- .../mutations/set-cart-inactive.md | 2 +- .../mutations/sync-payment-order.md | 2 +- .../schema/attributes/interfaces/index.md | 16 +++++++-------- .../mutations/set-custom-cart-item.md | 2 +- .../attributes/mutations/set-custom-cart.md | 2 +- .../mutations/set-custom-company.md | 2 +- .../mutations/set-custom-credit-memo-item.md | 2 +- .../mutations/set-custom-credit-memo.md | 2 +- .../mutations/set-custom-invoice-item.md | 2 +- .../mutations/set-custom-invoice.md | 2 +- .../mutations/set-custom-negotiable-quote.md | 2 +- .../queries/custom-attribute-metadata.md | 2 +- .../company/mutations/assign-child-company.md | 2 +- .../b2b/company/mutations/create-role.md | 4 ++-- .../b2b/company/mutations/create-team.md | 4 ++-- .../b2b/company/mutations/create-user.md | 4 ++-- .../schema/b2b/company/mutations/create.md | 4 ++-- .../b2b/company/mutations/delete-role.md | 4 ++-- .../b2b/company/mutations/delete-team.md | 4 ++-- .../b2b/company/mutations/delete-user.md | 2 +- .../mutations/unassign-child-company.md | 2 +- .../b2b/company/mutations/update-role.md | 4 ++-- .../b2b/company/mutations/update-structure.md | 4 ++-- .../b2b/company/mutations/update-team.md | 4 ++-- .../b2b/company/mutations/update-user.md | 4 ++-- .../schema/b2b/company/mutations/update.md | 4 ++-- .../schema/b2b/company/queries/company.md | 4 ++-- .../b2b/company/unions/structure-entity.md | 4 ++-- .../b2b/negotiable-quote/interfaces/index.md | 20 +++++++++---------- .../b2b/negotiable-quote/mutations/close.md | 4 ++-- .../b2b/negotiable-quote/mutations/delete.md | 4 ++-- .../mutations/place-order-v2.md | 2 +- .../negotiable-quote/mutations/place-order.md | 4 ++-- .../mutations/remove-items.md | 4 ++-- .../b2b/negotiable-quote/mutations/request.md | 4 ++-- .../mutations/send-for-review.md | 4 ++-- .../mutations/set-billing-address.md | 4 ++-- .../mutations/set-payment-method.md | 4 ++-- .../set-quote-template-expiration-date.md | 2 +- .../mutations/set-shipping-address.md | 4 ++-- .../mutations/set-shipping-methods.md | 4 ++-- .../mutations/update-quantities.md | 4 ++-- .../b2b/negotiable-quote/queries/quote.md | 4 ++-- .../b2b/negotiable-quote/unions/index.md | 20 +++++++++---------- .../schema/b2b/purchase-order-rule/index.md | 2 +- .../purchase-order-rule/interfaces/index.md | 12 +++++------ .../purchase-order-rule/mutations/create.md | 4 ++-- .../purchase-order-rule/mutations/delete.md | 4 ++-- .../purchase-order-rule/mutations/update.md | 4 ++-- .../purchase-order-rule/mutations/validate.md | 4 ++-- .../purchase-order/mutations/add-comment.md | 4 ++-- .../mutations/add-items-to-cart.md | 4 ++-- .../b2b/purchase-order/mutations/approve.md | 4 ++-- .../b2b/purchase-order/mutations/cancel.md | 4 ++-- .../purchase-order/mutations/place-order.md | 4 ++-- .../mutations/place-purchase-order.md | 4 ++-- .../b2b/purchase-order/mutations/reject.md | 4 ++-- .../b2b/requisition-list/interfaces/index.md | 14 ++++++------- .../b2b/requisition-list/interfaces/item.md | 14 ++++++------- .../mutations/add-items-to-cart.md | 4 ++-- .../mutations/add-products.md | 4 ++-- .../mutations/clear-customer-cart.md | 4 ++-- .../requisition-list/mutations/copy-items.md | 4 ++-- .../b2b/requisition-list/mutations/create.md | 4 ++-- .../mutations/delete-items.md | 4 ++-- .../b2b/requisition-list/mutations/delete.md | 4 ++-- .../import-shared-requisition-list.md | 2 +- .../requisition-list/mutations/move-items.md | 4 ++-- .../share-requisition-list-by-email.md | 2 +- .../share-requisition-list-by-token.md | 2 +- .../mutations/update-items.md | 4 ++-- .../b2b/requisition-list/mutations/update.md | 4 ++-- .../graphql/schema/cart/interfaces/index.md | 14 ++++++------- .../cart/mutations/add-bundle-products.md | 2 +- .../mutations/add-configurable-products.md | 2 +- .../mutations/add-downloadable-products.md | 2 +- .../schema/cart/mutations/add-products.md | 4 ++-- .../cart/mutations/add-simple-products.md | 2 +- .../cart/mutations/add-virtual-products.md | 2 +- .../schema/cart/mutations/apply-coupon.md | 4 ++-- .../schema/cart/mutations/apply-coupons.md | 4 ++-- .../schema/cart/mutations/apply-giftcard.md | 4 ++-- .../cart/mutations/apply-reward-points.md | 4 ++-- .../cart/mutations/apply-store-credit.md | 4 ++-- .../assign-customer-to-guest-cart.md | 4 ++-- .../schema/cart/mutations/clear-cart.md | 2 +- .../cart/mutations/create-empty-cart.md | 2 +- .../cart/mutations/create-guest-cart.md | 4 ++-- .../mutations/estimate-shipping-methods.md | 4 ++-- .../schema/cart/mutations/estimate-totals.md | 4 ++-- .../graphql/schema/cart/mutations/merge.md | 4 ++-- .../schema/cart/mutations/place-order.md | 4 ++-- .../cart/mutations/redeem-giftcard-balance.md | 4 ++-- .../schema/cart/mutations/remove-coupon.md | 4 ++-- .../schema/cart/mutations/remove-coupons.md | 4 ++-- .../schema/cart/mutations/remove-giftcard.md | 4 ++-- .../schema/cart/mutations/remove-item.md | 4 ++-- .../cart/mutations/remove-reward-points.md | 4 ++-- .../cart/mutations/remove-store-credit.md | 4 ++-- .../cart/mutations/set-billing-address.md | 4 ++-- .../schema/cart/mutations/set-gift-options.md | 4 ++-- .../schema/cart/mutations/set-guest-email.md | 4 ++-- .../cart/mutations/set-payment-method.md | 4 ++-- .../cart/mutations/set-payment-place-order.md | 2 +- .../cart/mutations/set-shipping-address.md | 4 ++-- .../cart/mutations/set-shipping-method.md | 4 ++-- .../schema/cart/mutations/update-items.md | 4 ++-- src/pages/graphql/schema/cart/queries/cart.md | 6 +++--- .../graphql/schema/cart/queries/index.md | 2 +- .../schema/cart/queries/pickup-locations.md | 4 ++-- .../create-braintree-client-token.md | 2 +- .../mutations/create-payflow-pro-token.md | 2 +- .../mutations/create-paypal-express-token.md | 2 +- .../mutations/delete-payment-token.md | 4 ++-- .../mutations/handle-payflow-pro-response.md | 2 +- .../queries/customer-payment-tokens.md | 4 ++-- src/pages/graphql/schema/customer/index.md | 2 +- .../customer/mutations/assign-compare-list.md | 4 ++-- .../customer/mutations/change-password.md | 4 ++-- .../customer/mutations/confirm-email.md | 4 ++-- .../customer/mutations/create-address.md | 4 ++-- .../schema/customer/mutations/create-v2.md | 4 ++-- .../schema/customer/mutations/create.md | 2 +- .../customer/mutations/delete-address-v2.md | 2 +- .../customer/mutations/delete-address.md | 4 ++-- .../mutations/exchange-otp-customer-token.md | 2 +- .../mutations/generate-token-as-admin.md | 4 ++-- .../customer/mutations/generate-token.md | 2 +- .../mutations/request-password-reset-email.md | 4 ++-- .../mutations/resend-confirmation-email.md | 4 ++-- .../customer/mutations/reset-password.md | 4 ++-- .../schema/customer/mutations/revoke-token.md | 4 ++-- .../mutations/send-email-to-friend.md | 2 +- .../subscribe-email-to-newsletter.md | 4 ++-- .../customer/mutations/update-address-v2.md | 2 +- .../customer/mutations/update-address.md | 4 ++-- .../schema/customer/mutations/update-email.md | 4 ++-- .../schema/customer/mutations/update-v2.md | 4 ++-- .../schema/customer/mutations/update.md | 2 +- .../schema/customer/queries/customer.md | 4 ++-- .../customer/queries/downloadable-products.md | 2 +- .../customer/queries/giftcard-account.md | 4 ++-- .../graphql/schema/customer/queries/orders.md | 2 +- .../mutations/add-registrants.md | 4 ++-- .../schema/gift-registry/mutations/create.md | 4 ++-- .../mutations/move-cart-items.md | 4 ++-- .../gift-registry/mutations/remove-items.md | 4 ++-- .../mutations/remove-registrants.md | 4 ++-- .../schema/gift-registry/mutations/remove.md | 4 ++-- .../schema/gift-registry/mutations/share.md | 4 ++-- .../gift-registry/mutations/update-items.md | 4 ++-- .../mutations/update-registrants.md | 4 ++-- .../schema/gift-registry/mutations/update.md | 4 ++-- .../gift-registry/queries/gift-registry.md | 4 ++-- .../orders/interfaces/credit-memo-item.md | 4 ++-- .../schema/orders/interfaces/invoice-item.md | 4 ++-- .../schema/orders/interfaces/order-item.md | 4 ++-- .../schema/orders/interfaces/shipment-item.md | 4 ++-- .../orders/mutations/add-return-comment.md | 4 ++-- .../orders/mutations/add-return-tracking.md | 4 ++-- .../schema/orders/mutations/cancel-order.md | 4 ++-- .../orders/mutations/confirm-cancel-order.md | 4 ++-- .../schema/orders/mutations/confirm-return.md | 4 ++-- .../mutations/remove-return-tracking.md | 4 ++-- .../schema/orders/mutations/reorder-items.md | 4 ++-- .../mutations/request-guest-order-cancel.md | 4 ++-- .../orders/mutations/request-guest-return.md | 4 ++-- .../schema/orders/mutations/request-return.md | 4 ++-- .../schema/products/interfaces/attributes.md | 4 ++-- .../schema/products/interfaces/category.md | 2 +- .../interfaces/customizable-option.md | 2 +- .../schema/products/interfaces/index.md | 4 ++-- .../schema/products/interfaces/routable.md | 2 +- .../products/interfaces/types/bundle.md | 10 +++++----- .../products/interfaces/types/configurable.md | 8 ++++---- .../products/interfaces/types/downloadable.md | 2 +- .../products/interfaces/types/gift-card.md | 8 ++++---- .../products/interfaces/types/grouped.md | 2 +- .../schema/products/interfaces/types/index.md | 16 +++++++-------- .../products/interfaces/types/simple.md | 8 ++++---- .../products/interfaces/types/virtual.md | 6 +++--- .../mutations/add-products-to-compare-list.md | 4 ++-- .../products/mutations/assign-compare-list.md | 4 ++-- .../products/mutations/create-compare-list.md | 4 ++-- .../products/mutations/create-review.md | 2 +- .../products/mutations/delete-compare-list.md | 4 ++-- .../mutations/remove-from-compare-list.md | 4 ++-- .../subscribe-product-alert-price.md | 2 +- .../subscribe-product-alert-stock.md | 2 +- .../unsubscribe-product-alert-price-all.md | 2 +- .../unsubscribe-product-alert-price.md | 2 +- .../unsubscribe-product-alert-stock-all.md | 2 +- .../schema/products/queries/compare-list.md | 4 ++-- .../product-review-ratings-metadata.md | 2 +- .../schema/products/queries/products.md | 2 +- .../schema/store/mutations/contact-us.md | 4 ++-- .../schema/store/queries/cms-blocks.md | 2 +- .../graphql/schema/store/queries/cms-page.md | 2 +- .../graphql/schema/store/queries/country.md | 4 ++-- .../graphql/schema/store/queries/currency.md | 4 ++-- .../schema/store/queries/dynamic-blocks.md | 2 +- .../schema/store/queries/store-config.md | 4 ++-- .../schema/uploads/mutations/finish-upload.md | 2 +- .../uploads/mutations/initiate-upload.md | 2 +- .../schema/wishlist/interfaces/wishlist.md | 4 ++-- .../wishlist/mutations/add-items-to-cart.md | 4 ++-- .../schema/wishlist/mutations/add-products.md | 4 ++-- .../schema/wishlist/mutations/clear.md | 2 +- .../wishlist/mutations/copy-products.md | 4 ++-- .../schema/wishlist/mutations/create.md | 4 ++-- .../schema/wishlist/mutations/delete.md | 4 ++-- .../wishlist/mutations/move-products.md | 4 ++-- .../wishlist/mutations/remove-products.md | 4 ++-- .../wishlist/mutations/update-products.md | 4 ++-- .../schema/wishlist/mutations/update.md | 4 ++-- .../schema/wishlist/queries/wishlist.md | 2 +- 222 files changed, 436 insertions(+), 436 deletions(-) diff --git a/src/pages/graphql/index.md b/src/pages/graphql/index.md index 4d04267fe..36f640b4c 100755 --- a/src/pages/graphql/index.md +++ b/src/pages/graphql/index.md @@ -11,9 +11,9 @@ keywords: Adobe Commerce provides two comprehensive GraphQL implementations that serve as the ideal foundation for building next-generation commerce experiences, including [headless storefronts](https://experienceleague.adobe.com/developer/commerce/storefront/get-started/) and sophisticated mobile applications. -- Adobe Commerce on Cloud and on-premises (PaaS) projects can implement the GraphQL schemas that have long been available to Adobe Commerce and Magento Open Source projects. Separate schemas are available for [core and B2B Commerce](../graphql/reference/2-4-8/index.md) functionality and service-based features, including [Catalog Service](schema/catalog-service/index.md), [Live Search](schema/live-search/index.md), and [Recommendations](schema/product-recommendations/index.md). These schemas do not natively interact, but can be integrated with [API Mesh](https://developer.adobe.com/graphql-mesh-gateway/). +- Adobe Commerce on Cloud and on-premises (PaaS) projects can implement the GraphQL schemas that have long been available to Adobe Commerce and Magento Open Source projects. Separate schemas are available for [core and B2B Commerce](../reference/graphql/2-4-8/index.md) functionality and service-based features, including [Catalog Service](schema/catalog-service/index.md), [Live Search](schema/live-search/index.md), and [Recommendations](schema/product-recommendations/index.md). These schemas do not natively interact, but can be integrated with [API Mesh](https://developer.adobe.com/graphql-mesh-gateway/). -- [Adobe Commerce as a Cloud Service](/graphql/reference/saas/index.md) (SaaS) projects can connect to a supergraph that not only combines and streamlines the schemas available to PaaS projects, but provides instant access to the latest features added in the [Storefront Compatability Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/storefront-compatibility/v248/) and other sources. Therefore, SaaS projects can take advantage of the latest GraphQL features without needing to wait for a new release. +- [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md) (SaaS) projects can connect to a supergraph that not only combines and streamlines the schemas available to PaaS projects, but provides instant access to the latest features added in the [Storefront Compatability Package](https://experienceleague.adobe.com/developer/commerce/storefront/setup/configuration/storefront-compatibility/v248/) and other sources. Therefore, SaaS projects can take advantage of the latest GraphQL features without needing to wait for a new release. 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 index 8cf5efb23..1fcac5e71 100644 --- 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 @@ -33,7 +33,7 @@ addProductsToNewCart( ## Reference -The [`addProductsToNewCart`](/reference/graphql/saas/index.md#addproductstonewcart) reference provides detailed information about the types and fields defined in this mutation. +The [`addProductsToNewCart`](/reference/graphql/saas/mutations.md#addproductstonewcart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage @@ -41,7 +41,7 @@ These examples show when the `addProductsToNewCart` mutation returns a successfu ### Create a new cart (success) -The following example adds a simple product to a new cart successfully, returning a [Cart](/reference/graphql/latest/index.md#cart) object. +The following example adds a simple product to a new cart successfully, returning a [Cart](/reference/graphql/latest/types-c-e.md#cart) object. **Request:** @@ -83,7 +83,7 @@ mutation { ### 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](/reference/graphql/latest/index.md#cartuserinputerror) object. +The following example fails to create a new cart beccause the `sku` does not exist in the catalog. It returns a [CartUserInputError](/reference/graphql/latest/types-c-e.md#cartuserinputerror) object. **Request:** diff --git a/src/pages/graphql/payment-services-extension/mutations/complete-order.md b/src/pages/graphql/payment-services-extension/mutations/complete-order.md index 3d50741f2..c6b2bf0df 100644 --- a/src/pages/graphql/payment-services-extension/mutations/complete-order.md +++ b/src/pages/graphql/payment-services-extension/mutations/complete-order.md @@ -44,7 +44,7 @@ mutation { ## Reference -The [`completeOrder`](/reference/graphql/saas/index.md#completeorder) reference provides detailed information about the types and fields defined in this mutation. +The [`completeOrder`](/reference/graphql/saas/mutations.md#completeorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md b/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md index 19f8a0644..16ce50e3c 100644 --- a/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md +++ b/src/pages/graphql/payment-services-extension/mutations/create-payment-order.md @@ -34,7 +34,7 @@ mutation { ## Reference -The [`createPaymentOrder`](/reference/graphql/saas/index.md#createpaymentorder) reference provides detailed information about the types and fields defined in this mutation. +The [`createPaymentOrder`](/reference/graphql/saas/mutations.md#createpaymentorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md index 23ca04ed8..e1089bdba 100644 --- a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md +++ b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-payment-token.md @@ -25,7 +25,7 @@ mutation { ## Reference -The [`createVaultCardPaymentToken`](/reference/graphql/saas/index.md#createvaultcardpaymenttoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createVaultCardPaymentToken`](/reference/graphql/saas/mutations.md#createvaultcardpaymenttoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md index ed06cf68d..dc15b1c9d 100644 --- a/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md +++ b/src/pages/graphql/payment-services-extension/mutations/create-vault-card-setup-token.md @@ -29,7 +29,7 @@ mutation { ## Reference -The [`createVaultCardSetupToken`](/reference/graphql/saas/index.md#createvaultcardsetuptoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createVaultCardSetupToken`](/reference/graphql/saas/mutations.md#createvaultcardsetuptoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage 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 index da898177c..9f8baf87b 100644 --- a/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md +++ b/src/pages/graphql/payment-services-extension/mutations/set-cart-inactive.md @@ -25,7 +25,7 @@ mutation { ## Reference -The [`setCartAsInactive`](/reference/graphql/saas/index.md#setcartasinactive) reference provides detailed information about the types and fields defined in this mutation. +The [`setCartAsInactive`](/reference/graphql/saas/mutations.md#setcartasinactive) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md b/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md index e2ca83b38..578c63533 100644 --- a/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md +++ b/src/pages/graphql/payment-services-extension/mutations/sync-payment-order.md @@ -25,7 +25,7 @@ mutation { ## Reference -The [`syncPaymentOrder`](/reference/graphql/saas/index.md#syncpaymentorder) reference provides detailed information about the types and fields defined in this mutation. +The [`syncPaymentOrder`](/reference/graphql/saas/mutations.md#syncpaymentorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/interfaces/index.md b/src/pages/graphql/schema/attributes/interfaces/index.md index 1af10811e..5877b769c 100644 --- a/src/pages/graphql/schema/attributes/interfaces/index.md +++ b/src/pages/graphql/schema/attributes/interfaces/index.md @@ -9,19 +9,19 @@ Adobe Commerce on cloud and on-premises (PaaS) provides the following interfaces | Interface | Implementations | | --- | --- | -| [`AttributeSelectedOptionInterface`](/reference/graphql/latest/index.md#attributeselectedoptioninterface) | [`AttributeSelectedOption`](/reference/graphql/latest/index.md#attributeselectedoption) | -| [`AttributeValueInterface`](/reference/graphql/latest/index.md#attributevalueinterface) | [`AttributeValue`](/reference/graphql/latest/index.md#attributevalue) \
[`AttributeSelectedOptions`](/reference/graphql/latest/index.md#attributeselectedoptions) | -| [`CustomAttributeMetadataInterface`](/reference/graphql/latest/index.md#customerattributemetadata) | [`AttributeMetadata`](/reference/graphql/latest/index.md#attributemetadata) | -| [`CustomAttributeOptionInterface`](/reference/graphql/latest/index.md#customattributeoptioninterface) | [`AttributeOptionMetadata`](/reference/graphql/latest/index.md#attributeoptionmetadata). | +| [`AttributeSelectedOptionInterface`](/reference/graphql/latest/types-a-b.md#attributeselectedoptioninterface) | [`AttributeSelectedOption`](/reference/graphql/latest/types-a-b.md#attributeselectedoption) | +| [`AttributeValueInterface`](/reference/graphql/latest/types-a-b.md#attributevalueinterface) | [`AttributeValue`](/reference/graphql/latest/types-a-b.md#attributevalue) \
[`AttributeSelectedOptions`](/reference/graphql/latest/types-a-b.md#attributeselectedoptions) | +| [`CustomAttributeMetadataInterface`](/reference/graphql/latest/types-c-e.md#customerattributemetadata) | [`AttributeMetadata`](/reference/graphql/latest/types-a-b.md#attributemetadata) | +| [`CustomAttributeOptionInterface`](/reference/graphql/latest/types-c-e.md#customattributeoptioninterface) | [`AttributeOptionMetadata`](/reference/graphql/latest/types-a-b.md#attributeoptionmetadata). | The following table lists the same interfaces and implementations with links to the **Adobe Commerce as a Cloud Service (SaaS)** GraphQL reference. | Interface | Implementations | | --- | --- | -| [`AttributeSelectedOptionInterface`](/reference/graphql/saas/index.md#attributeselectedoptioninterface) | [`AttributeSelectedOption`](/reference/graphql/saas/index.md#attributeselectedoption) | -| [`AttributeValueInterface`](/reference/graphql/saas/index.md#attributevalueinterface) | [`AttributeValue`](/reference/graphql/saas/index.md#attributevalue) \
[`AttributeSelectedOptions`](/reference/graphql/saas/index.md#attributeselectedoptions) \
[`AttributeFile`](/reference/graphql/saas/index.md#attributefile) \
[`AttributeImage`](/reference/graphql/saas/index.md#attributeimage) | -| [`CustomAttributeMetadataInterface`](/reference/graphql/saas/index.md#customerattributemetadata) | [`AttributeMetadata`](/reference/graphql/saas/index.md#attributemetadata) | -| [`CustomAttributeOptionInterface`](/reference/graphql/saas/index.md#customattributeoptioninterface) | [`AttributeOptionMetadata`](/reference/graphql/saas/index.md#attributeoptionmetadata). | +| [`AttributeSelectedOptionInterface`](/reference/graphql/saas/types-a-b.md#attributeselectedoptioninterface) | [`AttributeSelectedOption`](/reference/graphql/saas/types-a-b.md#attributeselectedoption) | +| [`AttributeValueInterface`](/reference/graphql/saas/types-a-b.md#attributevalueinterface) | [`AttributeValue`](/reference/graphql/saas/types-a-b.md#attributevalue) \
[`AttributeSelectedOptions`](/reference/graphql/saas/types-a-b.md#attributeselectedoptions) \
[`AttributeFile`](/reference/graphql/saas/types-a-b.md#attributefile) \
[`AttributeImage`](/reference/graphql/saas/types-a-b.md#attributeimage) | +| [`CustomAttributeMetadataInterface`](/reference/graphql/saas/types-c-e.md#customerattributemetadata) | [`AttributeMetadata`](/reference/graphql/saas/types-a-b.md#attributemetadata) | +| [`CustomAttributeOptionInterface`](/reference/graphql/saas/types-c-e.md#customattributeoptioninterface) | [`AttributeOptionMetadata`](/reference/graphql/saas/types-a-b.md#attributeoptionmetadata). | 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 e21520a7e..70b05f9c5 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 @@ -29,7 +29,7 @@ mutation { The `setCustomAttributesOnCartItem` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setcustomattributesoncartitem) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setcustomattributesoncartitem) ## 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 d2168e006..b779d74c2 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-cart.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-cart.md @@ -29,7 +29,7 @@ mutation { The `setCustomAttributesOnCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setcustomattributesoncart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setcustomattributesoncart) ## 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 24c1f85b2..03abc51e7 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-company.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-company.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`setCustomAttributesOnCompany`](/reference/graphql/saas/index.md#setcustomattributesoncompany) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnCompany`](/reference/graphql/saas/mutations.md#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 10d0130c7..a58887469 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 @@ -27,7 +27,7 @@ mutation { The `setCustomAttributesOnCreditMemoItem` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setcustomattributesoncreditmemoitem) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setcustomattributesoncreditmemoitem) ## 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 a954bb6fb..806b435f2 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 @@ -27,7 +27,7 @@ mutation { The `setCustomAttributesOnCreditMemo` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setcustomattributesoncreditmemo) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setcustomattributesoncreditmemo) ## 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 e8023ee24..84904be04 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 @@ -27,7 +27,7 @@ mutation { The `setCustomAttributesOnInvoiceItem` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setcustomattributesoninvoiceitem) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setcustomattributesoninvoiceitem) ## 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 91094a45b..68914ece7 100644 --- a/src/pages/graphql/schema/attributes/mutations/set-custom-invoice.md +++ b/src/pages/graphql/schema/attributes/mutations/set-custom-invoice.md @@ -27,7 +27,7 @@ mutation { The `setCustomAttributesOnInvoice` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setcustomattributesoninvoice) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setcustomattributesoninvoice) ## 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 fbdf3d267..a5cf60b7c 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 @@ -28,7 +28,7 @@ mutation { ## Reference -The [`setCustomAttributesOnNegotiableQuote`](/reference/graphql/saas/index.md#setcustomattributesonnegotiablequote) reference provides detailed information about the types and fields defined in this mutation. +The [`setCustomAttributesOnNegotiableQuote`](/reference/graphql/saas/mutations.md#setcustomattributesonnegotiablequote) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md index 3b0e2e1e6..35ceb0bfd 100644 --- a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md +++ b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md @@ -21,7 +21,7 @@ The `StorefrontProperties` output object returns information about a product att The `customAttributeMetadata` reference provides detailed information about the types and fields defined in this query. -* [On-Premises/Cloud](/reference/graphql/latest/index.md#customattributemetadata) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#customattributemetadata) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/assign-child-company.md b/src/pages/graphql/schema/b2b/company/mutations/assign-child-company.md index 3435a16de..21b03be2f 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/assign-child-company.md +++ b/src/pages/graphql/schema/b2b/company/mutations/assign-child-company.md @@ -29,7 +29,7 @@ The `assignChildCompany` mutation allows company administrators to assign a chil [//]: # (## Reference) [//]: # () -[//]: # (The [`assignChildCompany`](/reference/graphql/saas/index.md#assignchildcompany) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`assignChildCompany`](/reference/graphql/saas/mutations.md#assignchildcompany) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create-role.md b/src/pages/graphql/schema/b2b/company/mutations/create-role.md index 241b73a51..c45994f3f 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create-role.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create-role.md @@ -33,9 +33,9 @@ mutation { The `createCompanyRole` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompanyrole) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcompanyrole) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompanyrole) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcompanyrole) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create-team.md b/src/pages/graphql/schema/b2b/company/mutations/create-team.md index eb22024f9..34cd4ca4d 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create-team.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create-team.md @@ -33,9 +33,9 @@ mutation { The `createCompanyTeam` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompanyteam) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcompanyteam) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompanyteam) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcompanyteam) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create-user.md b/src/pages/graphql/schema/b2b/company/mutations/create-user.md index 0520f4a43..10fa5131f 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create-user.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create-user.md @@ -39,9 +39,9 @@ mutation { The `createCompanyUser` reference provides detailed information about the types and fields defined in this mutation. -- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompanyuser) +- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcompanyuser) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompanyuser) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcompanyuser) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/create.md b/src/pages/graphql/schema/b2b/company/mutations/create.md index aa97566f0..a39dc4cc3 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/create.md +++ b/src/pages/graphql/schema/b2b/company/mutations/create.md @@ -29,9 +29,9 @@ mutation { The `createCompany` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcompany) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcompany) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcompany) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcompany) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/delete-role.md b/src/pages/graphql/schema/b2b/company/mutations/delete-role.md index 2ed753aa7..a0f07be3a 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/delete-role.md +++ b/src/pages/graphql/schema/b2b/company/mutations/delete-role.md @@ -31,9 +31,9 @@ mutation { The `deleteCompanyRole` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecompanyrole) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletecompanyrole) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecompanyrole) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletecompanyrole) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/delete-team.md b/src/pages/graphql/schema/b2b/company/mutations/delete-team.md index 80e8cfd44..f05d7d938 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/delete-team.md +++ b/src/pages/graphql/schema/b2b/company/mutations/delete-team.md @@ -29,9 +29,9 @@ mutation { The `deleteCompanyTeam` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecompanyteam) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletecompanyteam) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecompanyteam) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletecompanyteam) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/delete-user.md b/src/pages/graphql/schema/b2b/company/mutations/delete-user.md index e49330dae..232b193b2 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/delete-user.md +++ b/src/pages/graphql/schema/b2b/company/mutations/delete-user.md @@ -31,7 +31,7 @@ mutation { ## Reference -The [`deleteCompanyUser`](/reference/graphql/latest/index.md#deletecompanyuser) reference provides detailed information about the types and fields defined in this mutation. +The [`deleteCompanyUser`](/reference/graphql/latest/mutations.md#deletecompanyuser) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/unassign-child-company.md b/src/pages/graphql/schema/b2b/company/mutations/unassign-child-company.md index 273052d4b..dc5d542b0 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/unassign-child-company.md +++ b/src/pages/graphql/schema/b2b/company/mutations/unassign-child-company.md @@ -29,7 +29,7 @@ The `unassignChildCompany` mutation allows company administrators to unassign a [//]: # (## Reference) [//]: # () -[//]: # (The [`unassignChildCompany`](/reference/graphql/saas/index.md#unassignchildcompany) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`unassignChildCompany`](/reference/graphql/saas/mutations.md#unassignchildcompany) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-role.md b/src/pages/graphql/schema/b2b/company/mutations/update-role.md index cb9a4da6f..fe33121b8 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-role.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-role.md @@ -39,9 +39,9 @@ mutation { The `updateCompanyRole` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanyrole) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecompanyrole) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanyrole) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecompanyrole) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-structure.md b/src/pages/graphql/schema/b2b/company/mutations/update-structure.md index 5dbc3e162..ae490dc24 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-structure.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-structure.md @@ -29,9 +29,9 @@ mutation { The `updateCompanyStructure` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanystructure) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecompanystructure) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanystructure) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecompanystructure) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-team.md b/src/pages/graphql/schema/b2b/company/mutations/update-team.md index b60e8e9ce..0fdc83393 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-team.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-team.md @@ -29,9 +29,9 @@ mutation { The `updateCompanyTeam` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanyteam) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecompanyteam) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanyteam) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecompanyteam) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update-user.md b/src/pages/graphql/schema/b2b/company/mutations/update-user.md index 5526b050a..1d882fbb6 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update-user.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update-user.md @@ -31,9 +31,9 @@ mutation { The `updateCompanyUser` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompanyuser) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecompanyuser) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompanyuser) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecompanyuser) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/mutations/update.md b/src/pages/graphql/schema/b2b/company/mutations/update.md index f8d008082..5ce3d6710 100644 --- a/src/pages/graphql/schema/b2b/company/mutations/update.md +++ b/src/pages/graphql/schema/b2b/company/mutations/update.md @@ -29,9 +29,9 @@ mutation { The `updateCompany` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecompany) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecompany) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecompany) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecompany) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/company.md b/src/pages/graphql/schema/b2b/company/queries/company.md index 9b6869b1a..dcd88e927 100644 --- a/src/pages/graphql/schema/b2b/company/queries/company.md +++ b/src/pages/graphql/schema/b2b/company/queries/company.md @@ -25,9 +25,9 @@ This query requires a valid [customer authentication token](../../../customer/mu The `company` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#company) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#company) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#company) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#company) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/unions/structure-entity.md b/src/pages/graphql/schema/b2b/company/unions/structure-entity.md index 76205ea8e..c43f662b3 100644 --- a/src/pages/graphql/schema/b2b/company/unions/structure-entity.md +++ b/src/pages/graphql/schema/b2b/company/unions/structure-entity.md @@ -19,9 +19,9 @@ The `CompanyStructureEntity` union provides details about a node in a company st The `CompanyStructureEntity` reference provides detailed information about the types and fields defined in this union. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#companystructureentity) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#companystructureentity) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#companystructureentity) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#companystructureentity) **Possible types:** diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md b/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md index a474c48e1..6ecaef5aa 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/interfaces/index.md @@ -13,30 +13,30 @@ Negotiable quote queries and mutations can access the following interfaces: * `NegotiableQuoteAddressInterface` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteaddressinterface) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequoteaddressinterface) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteaddressinterface) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequoteaddressinterface) It is implemented by `NegotiableQuoteShippingAddress` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteshippingaddress) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequoteshippingaddress) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteshippingaddress) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequoteshippingaddress) and `NegotiableQuoteBillingAddress` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequotebillingaddress) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequotebillingaddress) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequotebillingaddress) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequotebillingaddress) * `NegotiableQuoteUidNonFatalResultInterface` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteuidnonfatalresultinterface) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequoteuidnonfatalresultinterface) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteuidnonfatalresultinterface) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequoteuidnonfatalresultinterface) It is implemented by `NegotiableQuoteUidOperationSuccess` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequoteuidoperationsuccess) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequoteuidoperationsuccess) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequoteuidoperationsuccess) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequoteuidoperationsuccess) diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md index 52f072f51..e94f82ca6 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/close.md @@ -33,9 +33,9 @@ This mutation requires a valid [customer authentication token](../../../customer The `closeNegotiableQuotes` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#closenegotiablequotes) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#closenegotiablequotes) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#closenegotiablequotes) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#closenegotiablequotes) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md index 06a643023..776cc28dd 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/delete.md @@ -34,9 +34,9 @@ deleteNegotiableQuotes( The `deleteNegotiableQuotes` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletenegotiablequotes) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletenegotiablequotes) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletenegotiablequotes) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletenegotiablequotes) The [`DeleteNegotiableQuoteOperationResult` union](../unions/index.md) is an output object that provides details about the result of a request to delete a negotiable quote. To return these details, specify fragments on the `DeleteNegotiableQuoteOperationFailure` and `NegotiableQuoteUidOperationSuccess` objects. Specify the `__typename` attribute to distinguish the object types in the response. 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 index d9edb0ebe..827bec111 100644 --- 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 @@ -51,7 +51,7 @@ mutation { ## Reference -The [`placeNegotiableQuoteOrderV2`](/reference/graphql/saas/index.md#placenegotiablequoteorderv2) reference provides detailed information about the types and fields defined in this mutation. +The [`placeNegotiableQuoteOrderV2`](/reference/graphql/saas/mutations.md#placenegotiablequoteorderv2) 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/place-order.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/place-order.md index 2af5955e0..d8343ed87 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 @@ -51,9 +51,9 @@ mutation { The `placeNegotiableQuoteOrder` reference provides detailed information about the types and fields defined in this mutation. -- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placenegotiablequoteorder) +- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#placenegotiablequoteorder) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#placenegotiablequoteorder) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/mutations.md#placenegotiablequoteorder) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md index 181a377b5..58a5ca710 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/remove-items.md @@ -29,9 +29,9 @@ This mutation requires a valid [customer authentication token](../../../customer The `removeNegotiableQuoteItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removenegotiablequoteitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removenegotiablequoteitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removenegotiablequoteitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removenegotiablequoteitems) ## Example usage 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 596424593..d256c6148 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/request.md @@ -33,9 +33,9 @@ requestNegotiableQuote( The `requestNegotiableQuote` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestnegotiablequote) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#requestnegotiablequote) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestnegotiablequote) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#requestnegotiablequote) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md index ebf0d6b70..6c1f3d4fe 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/send-for-review.md @@ -25,9 +25,9 @@ sendNegotiableQuoteForReview( The `sendNegotiableQuoteForReview` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#sendnegotiablequoteforreview) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#sendnegotiablequoteforreview) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#sendnegotiablequoteforreview) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#sendnegotiablequoteforreview) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md index 05936db4b..9ae0648b1 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address.md @@ -29,9 +29,9 @@ This query requires a valid [customer authentication token](../../../customer/mu The `setNegotiableQuoteBillingAddress` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequotebillingaddress) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setnegotiablequotebillingaddress) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequotebillingaddress) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setnegotiablequotebillingaddress) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md index 739a84f17..3c6a9b8ab 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method.md @@ -49,9 +49,9 @@ This mutation requires a valid [customer authentication token](../../../customer The `setNegotiableQuotePaymentMethod` reference provides detailed information about the types and fields defined in this mutation. -- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequotepaymentmethod) +- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setnegotiablequotepaymentmethod) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequotepaymentmethod) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setnegotiablequotepaymentmethod) ## Example usage 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 index 53d2749df..ca4c02f20 100644 --- 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 @@ -29,7 +29,7 @@ The `setQuoteTemplateExpirationDate` mutation can be used to set an expiration d ## Reference -The [`setQuoteTemplateExpirationDate`](/reference/graphql/saas/index.md#setquotetemplateexpirationdate) reference provides detailed information about the types and fields defined in this mutation. +The [`setQuoteTemplateExpirationDate`](/reference/graphql/saas/mutations.md#setquotetemplateexpirationdate) 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/set-shipping-address.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md index 0617d4460..472a7f97d 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address.md @@ -29,9 +29,9 @@ This query requires a valid [customer authentication token](../../../customer/mu The `setNegotiableQuoteShippingAddress` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequoteshippingaddress) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setnegotiablequoteshippingaddress) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequoteshippingaddress) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setnegotiablequoteshippingaddress) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md index eff400618..c13cc347a 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods.md @@ -37,9 +37,9 @@ setNegotiableQuoteShippingMethods( The `setNegotiableQuoteShippingMethods` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setnegotiablequoteshippingmethods) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setnegotiablequoteshippingmethods) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setnegotiablequoteshippingmethods) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setnegotiablequoteshippingmethods) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md index fa73672fe..44f3e987a 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/mutations/update-quantities.md @@ -29,9 +29,9 @@ updateNegotiableQuoteQuantities( The `updateNegotiableQuoteQuantities` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatenegotiablequotequantities) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatenegotiablequotequantities) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatenegotiablequotequantities) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatenegotiablequotequantities) ## Example usage 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 6f5b8a057..021efcb46 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md @@ -23,9 +23,9 @@ negotiableQuote (uid ID!): NegotiableQuote The `negotiableQuote` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequote) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequote) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequote) +* [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequote) ## Example usage diff --git a/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md b/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md index 0bf1c3274..4c8f48b4f 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/unions/index.md @@ -17,9 +17,9 @@ See the GraphQL specification for more details about [unions](https://graphql.or The `CloseNegotiableQuoteError` union provides details about failed attempts to close one or more negotiable quotes. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#closenegotiablequoteerror) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#closenegotiablequoteerror) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#closenegotiablequoteerror) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#closenegotiablequoteerror) **Possible types:** @@ -35,9 +35,9 @@ The `CloseNegotiableQuoteError` union provides details about failed attempts to The `CloseNegotiableQuoteOperationResult` union provides details about the result of a request to close a negotiable quote. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#closenegotiablequoteoperationresult) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#closenegotiablequoteoperationresult) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#closenegotiablequoteoperationresult) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#closenegotiablequoteoperationresult) **Possible types:** @@ -52,9 +52,9 @@ The `CloseNegotiableQuoteOperationResult` union provides details about the resul The `CompanyStructureEntity` union provides details about a node in a company structure. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#companystructureentity) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#companystructureentity) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#companystructureentity) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#companystructureentity) **Possible types:** @@ -69,9 +69,9 @@ The `CompanyStructureEntity` union provides details about a node in a company st The `DeleteNegotiableQuoteError` union provides details about failed attempts to delete one or more negotiable quotes. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletenegotiablequoteerror) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#deletenegotiablequoteerror) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletenegotiablequoteerror) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#deletenegotiablequoteerror) **Possible types:** @@ -87,9 +87,9 @@ The `DeleteNegotiableQuoteError` union provides details about failed attempts to The `DeleteNegotiableQuoteOperationResult` union provides details about the result of a request to delete a negotiable quote. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletenegotiablequoteoperationresult) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#deletenegotiablequoteoperationresult) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletenegotiablequoteoperationresult) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#deletenegotiablequoteoperationresult) **Possible types:** diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/index.md b/src/pages/graphql/schema/b2b/purchase-order-rule/index.md index 9f2fd89bb..9330e2507 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/index.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/index.md @@ -84,7 +84,7 @@ The following example returns the list of purchase order approval rules. ## Get approval rule details -The `purchase_order_approval_rule` query returns information about the specified approval rule. To retrieve details about the amount or quantity required to trigger an approval rule, you must specify the implementations of the [`PurchaseOrderApprovalRuleConditionInterface`](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditioninterface). +The `purchase_order_approval_rule` query returns information about the specified approval rule. To retrieve details about the amount or quantity required to trigger an approval rule, you must specify the implementations of the [`PurchaseOrderApprovalRuleConditionInterface`](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruleconditioninterface). The following example returns information about the purchase order approval rule. diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md b/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md index b5bf04962..8544d978d 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/interfaces/index.md @@ -11,23 +11,23 @@ keywords: `PurchaseOrderApprovalRuleConditionInterface` provides details about the approval rule conditions. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#purchaseorderapprovalruleconditioninterface) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalruleconditioninterface) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditioninterface) +* [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruleconditioninterface) It has the following implementations: * `PurchaseOrderApprovalRuleConditionAmount` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#purchaseorderapprovalruleconditionamount) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalruleconditionamount) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditionamount) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruleconditionamount) * `PurchaseOrderApprovalRuleConditionQuantity` - * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#purchaseorderapprovalruleconditionquantity) + * [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#purchaseorderapprovalruleconditionquantity) - * [On-Premises/Cloud](/reference/graphql/latest/index.md#purchaseorderapprovalruleconditionquantity) + * [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#purchaseorderapprovalruleconditionquantity) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md index 305dbfcbf..7e19dd00e 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/create.md @@ -39,9 +39,9 @@ mutation { The `createPurchaseOrderApprovalRule` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createpurchaseorderapprovalrule) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createpurchaseorderapprovalrule) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createpurchaseorderapprovalrule) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createpurchaseorderapprovalrule) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md index 2e12b8b3b..f49545049 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/delete.md @@ -31,9 +31,9 @@ mutation { The `deletePurchaseOrderApprovalRule` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletepurchaseorderapprovalrule) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletepurchaseorderapprovalrule) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletepurchaseorderapprovalrule) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletepurchaseorderapprovalrule) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md index 1ede123de..6d2cd43ea 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/update.md @@ -31,9 +31,9 @@ mutation { The `updatePurchaseOrderApprovalRule` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatepurchaseorderapprovalrule) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatepurchaseorderapprovalrule) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatepurchaseorderapprovalrule) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatepurchaseorderapprovalrule) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md index 6fc7d5f6a..6c0568dd0 100644 --- a/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md +++ b/src/pages/graphql/schema/b2b/purchase-order-rule/mutations/validate.md @@ -29,9 +29,9 @@ mutation { The `validatePurchaseOrders` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#validatepurchaseorders) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#validatepurchaseorders) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#validatepurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#validatepurchaseorders) ## Headers diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md index 8656de757..1f217fb3b 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/add-comment.md @@ -27,9 +27,9 @@ mutation { The `addPurchaseOrderComment` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addpurchaseordercomment) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addpurchaseordercomment) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addpurchaseordercomment) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addpurchaseordercomment) ## Example usage 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 e812fc0b2..8665299fd 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 @@ -27,9 +27,9 @@ mutation { The `addPurchaseOrderItemsToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addpurchaseorderitemstocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addpurchaseorderitemstocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addpurchaseorderitemstocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addpurchaseorderitemstocart) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md index 744a537f2..bab61a90a 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/approve.md @@ -27,9 +27,9 @@ mutation { The `approvePurchaseOrders` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#approvepurchaseorders) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#approvepurchaseorders) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#approvepurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#approvepurchaseorders) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md index 7162fb1bc..bb42886cd 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/cancel.md @@ -27,9 +27,9 @@ mutation { The `cancelPurchaseOrders` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cancelpurchaseorders) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#cancelpurchaseorders) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#cancelpurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#cancelpurchaseorders) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md index f43ff9fdd..c21a32da5 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-order.md @@ -31,9 +31,9 @@ mutation { The `placeOrderForPurchaseOrder` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placeorderforpurchaseorder) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#placeorderforpurchaseorder) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#placeorderforpurchaseorder) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#placeorderforpurchaseorder) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md index 3de6b54bd..205a38905 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/place-purchase-order.md @@ -31,9 +31,9 @@ mutation { The `placePurchaseOrder` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placepurchaseorder) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#placepurchaseorder) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#placepurchaseorder) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#placepurchaseorder) ## Example usage diff --git a/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md b/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md index 9bb091ace..4cf6e0f1d 100644 --- a/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md +++ b/src/pages/graphql/schema/b2b/purchase-order/mutations/reject.md @@ -27,9 +27,9 @@ mutation { The `rejectPurchaseOrders` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#rejectpurchaseorders) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#rejectpurchaseorders) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#rejectpurchaseorders) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#rejectpurchaseorders) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md b/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md index f86d338ba..f71e6101a 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md +++ b/src/pages/graphql/schema/b2b/requisition-list/interfaces/index.md @@ -9,14 +9,14 @@ keywords: # RequisitionListItemInterface attributes and implementations -[`RequisitionListItemInterface`](/reference/graphql/latest/index.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: +[`RequisitionListItemInterface`](/reference/graphql/latest/types-q-s.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: -* [`BundleRequisitionListItem`](/reference/graphql/latest/index.md#bundlerequisitionlistitem) -* [`ConfigurableRequisitionListItem`](/reference/graphql/latest/index.md#configurablerequisitionlistitem) -* [`DownloadableRequisitionListItem`](/reference/graphql/latest/index.md#downloadablerequisitionlistitem) -* [`GiftCardRequisitionListItem`](/reference/graphql/latest/index.md#giftcardrequisitionlistitem) -* [`SimpleRequisitionListItem`](/reference/graphql/latest/index.md#simplerequisitionlistitem) -* [`VirtualRequisitionListItem`](/reference/graphql/latest/index.md#virtualrequisitionlistitem) +* [`BundleRequisitionListItem`](/reference/graphql/latest/types-a-b.md#bundlerequisitionlistitem) +* [`ConfigurableRequisitionListItem`](/reference/graphql/latest/types-c-e.md#configurablerequisitionlistitem) +* [`DownloadableRequisitionListItem`](/reference/graphql/latest/types-c-e.md#downloadablerequisitionlistitem) +* [`GiftCardRequisitionListItem`](/reference/graphql/latest/types-f-i.md#giftcardrequisitionlistitem) +* [`SimpleRequisitionListItem`](/reference/graphql/latest/types-q-s.md#simplerequisitionlistitem) +* [`VirtualRequisitionListItem`](/reference/graphql/latest/types-t-z.md#virtualrequisitionlistitem) diff --git a/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md b/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md index f86d338ba..f71e6101a 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md +++ b/src/pages/graphql/schema/b2b/requisition-list/interfaces/item.md @@ -9,14 +9,14 @@ keywords: # RequisitionListItemInterface attributes and implementations -[`RequisitionListItemInterface`](/reference/graphql/latest/index.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: +[`RequisitionListItemInterface`](/reference/graphql/latest/types-q-s.md#requisitionlistiteminterface) provides details about items in a requisition list. It has the following implementations: -* [`BundleRequisitionListItem`](/reference/graphql/latest/index.md#bundlerequisitionlistitem) -* [`ConfigurableRequisitionListItem`](/reference/graphql/latest/index.md#configurablerequisitionlistitem) -* [`DownloadableRequisitionListItem`](/reference/graphql/latest/index.md#downloadablerequisitionlistitem) -* [`GiftCardRequisitionListItem`](/reference/graphql/latest/index.md#giftcardrequisitionlistitem) -* [`SimpleRequisitionListItem`](/reference/graphql/latest/index.md#simplerequisitionlistitem) -* [`VirtualRequisitionListItem`](/reference/graphql/latest/index.md#virtualrequisitionlistitem) +* [`BundleRequisitionListItem`](/reference/graphql/latest/types-a-b.md#bundlerequisitionlistitem) +* [`ConfigurableRequisitionListItem`](/reference/graphql/latest/types-c-e.md#configurablerequisitionlistitem) +* [`DownloadableRequisitionListItem`](/reference/graphql/latest/types-c-e.md#downloadablerequisitionlistitem) +* [`GiftCardRequisitionListItem`](/reference/graphql/latest/types-f-i.md#giftcardrequisitionlistitem) +* [`SimpleRequisitionListItem`](/reference/graphql/latest/types-q-s.md#simplerequisitionlistitem) +* [`VirtualRequisitionListItem`](/reference/graphql/latest/types-t-z.md#virtualrequisitionlistitem) diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md index 8992815a2..0881e60c2 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-items-to-cart.md @@ -34,9 +34,9 @@ mutation { The `addRequisitionListItemsToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addrequisitionlistitemstocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addrequisitionlistitemstocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addrequisitionlistitemstocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addrequisitionlistitemstocart) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md index b352572df..6cc672f46 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/add-products.md @@ -34,9 +34,9 @@ mutation { The `addProductsToRequisitionList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstorequisitionlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addproductstorequisitionlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstorequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addproductstorequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md index 8418ed8ae..9e52e2b2e 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart.md @@ -33,9 +33,9 @@ mutation { The `clearCustomerCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#clearcustomercart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#clearcustomercart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#clearcustomercart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#clearcustomercart) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md index 1111994b9..82afb0974 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/copy-items.md @@ -35,9 +35,9 @@ mutation { The `copyItemsBetweenRequisitionLists` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#copyitemsbetweenrequisitionlists) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#copyitemsbetweenrequisitionlists) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#copyitemsbetweenrequisitionlists) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#copyitemsbetweenrequisitionlists) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md index 1fae00ebf..2db292255 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/create.md @@ -34,9 +34,9 @@ mutation { The `createRequisitionList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createrequisitionlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createrequisitionlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createrequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createrequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md index 3ec46097e..b8e85a213 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete-items.md @@ -34,9 +34,9 @@ mutation { The `deleteRequisitionListItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deleterequisitionlistitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deleterequisitionlistitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deleterequisitionlistitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deleterequisitionlistitems) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md index a1256c28a..7ba31f5b6 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/delete.md @@ -33,9 +33,9 @@ mutation { The `deleteRequisitionList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deleterequisitionlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deleterequisitionlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deleterequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deleterequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/import-shared-requisition-list.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/import-shared-requisition-list.md index 90b3809be..d944ec1bd 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/import-shared-requisition-list.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/import-shared-requisition-list.md @@ -29,7 +29,7 @@ The `importSharedRequisitionList` mutation allows recipients within the same com [//]: # (## Reference) [//]: # () -[//]: # (The [`importSharedRequisitionList`](/reference/graphql/saas/index.md#importsharedrequisitionlist) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`importSharedRequisitionList`](/reference/graphql/saas/mutations.md#importsharedrequisitionlist) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md index 00e9ea23e..133a28b16 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/move-items.md @@ -35,9 +35,9 @@ mutation { The `moveItemsBetweenRequisitionLists` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#moveitemsbetweenrequisitionlists) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#moveitemsbetweenrequisitionlists) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#moveitemsbetweenrequisitionlists) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#moveitemsbetweenrequisitionlists) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-email.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-email.md index 653c4f60b..af2d564a4 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-email.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-email.md @@ -29,7 +29,7 @@ The `shareRequisitionListByEmail` mutation enables B2B customers to share a requ [//]: # (## Reference) [//]: # () -[//]: # (The [`shareRequisitionListByEmail`](/reference/graphql/saas/index.md#sharerequisitionlistbyemail) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`shareRequisitionListByEmail`](/reference/graphql/saas/mutations.md#sharerequisitionlistbyemail) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-token.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-token.md index ca9c82a8d..34dd2a7b7 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-token.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-token.md @@ -29,7 +29,7 @@ The `shareRequisitionListByToken` mutation enables B2B customers to share a requ [//]: # (## Reference) [//]: # () -[//]: # (The [`shareRequisitionListByToken`](/reference/graphql/saas/index.md#sharerequisitionlistbytoken) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`shareRequisitionListByToken`](/reference/graphql/saas/mutations.md#sharerequisitionlistbytoken) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md index 905375497..b21e407b6 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/update-items.md @@ -34,9 +34,9 @@ mutation { The `updateRequisitionListItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updaterequisitionlistitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updaterequisitionlistitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updaterequisitionlistitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updaterequisitionlistitems) ## Example usage diff --git a/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md b/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md index 734dc367f..f825933a1 100644 --- a/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md +++ b/src/pages/graphql/schema/b2b/requisition-list/mutations/update.md @@ -35,9 +35,9 @@ mutation { The `updateRequisitionList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updaterequisitionlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updaterequisitionlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updaterequisitionlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updaterequisitionlist) ## Example usage diff --git a/src/pages/graphql/schema/cart/interfaces/index.md b/src/pages/graphql/schema/cart/interfaces/index.md index 3c7958a5c..1ccdc010a 100644 --- a/src/pages/graphql/schema/cart/interfaces/index.md +++ b/src/pages/graphql/schema/cart/interfaces/index.md @@ -5,14 +5,14 @@ description: The CartItemInterface has the following implementations: # CartItemInterface attributes and implementations -The [`CartItemInterface`](/reference/graphql/latest/index.md#cartiteminterface) has the following implementations: +The [`CartItemInterface`](/reference/graphql/latest/types-c-e.md#cartiteminterface) has the following implementations: -* [BundleCartItem](/reference/graphql/latest/index.md#bundlecartitem) -* [ConfigurableCartItem](/reference/graphql/latest/index.md#configurablecartitem) -* [DownloadableCartItem](/reference/graphql/latest/index.md#downloadablecartitem) -* [GiftCardCartItem](/reference/graphql/latest/index.md#giftcardcartitem) -* [SimpleCartItem](/reference/graphql/latest/index.md#simplecartitem) -* [VirtualCartItem](/reference/graphql/latest/index.md#virtualcartitem) +* [BundleCartItem](/reference/graphql/latest/types-a-b.md#bundlecartitem) +* [ConfigurableCartItem](/reference/graphql/latest/types-c-e.md#configurablecartitem) +* [DownloadableCartItem](/reference/graphql/latest/types-c-e.md#downloadablecartitem) +* [GiftCardCartItem](/reference/graphql/latest/types-f-i.md#giftcardcartitem) +* [SimpleCartItem](/reference/graphql/latest/types-q-s.md#simplecartitem) +* [VirtualCartItem](/reference/graphql/latest/types-t-z.md#virtualcartitem) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-bundle-products.md b/src/pages/graphql/schema/cart/mutations/add-bundle-products.md index e2faee9a9..038a96390 100644 --- a/src/pages/graphql/schema/cart/mutations/add-bundle-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-bundle-products.md @@ -19,7 +19,7 @@ Use the `addBundleProductsToCart` mutation to add bundle products to a specific ## Reference -The [`addBundleProductsToCart`](/reference/graphql/latest/index.md#addbundleproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addBundleProductsToCart`](/reference/graphql/latest/mutations.md#addbundleproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-configurable-products.md b/src/pages/graphql/schema/cart/mutations/add-configurable-products.md index 47a446a83..8e9027046 100644 --- a/src/pages/graphql/schema/cart/mutations/add-configurable-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-configurable-products.md @@ -20,7 +20,7 @@ Use the `addConfigurableProductsToCart` mutation to add configurable products to ## Reference -The [`addConfigurableProductsToCart`](/reference/graphql/latest/index.md#addconfigurableproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addConfigurableProductsToCart`](/reference/graphql/latest/mutations.md#addconfigurableproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md b/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md index e0f587a99..7da9224fa 100644 --- a/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-downloadable-products.md @@ -27,7 +27,7 @@ mutation: { ## Reference -The [`addDownloadableProductsToCart`](/reference/graphql/latest/index.md#adddownloadableproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addDownloadableProductsToCart`](/reference/graphql/latest/mutations.md#adddownloadableproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-products.md b/src/pages/graphql/schema/cart/mutations/add-products.md index b7556d83f..fee1a68b1 100644 --- a/src/pages/graphql/schema/cart/mutations/add-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-products.md @@ -50,9 +50,9 @@ mutation { The `addProductsToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addproductstocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addproductstocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-simple-products.md b/src/pages/graphql/schema/cart/mutations/add-simple-products.md index 518525231..c72b4f0c4 100644 --- a/src/pages/graphql/schema/cart/mutations/add-simple-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-simple-products.md @@ -24,7 +24,7 @@ To add a simple or grouped product to a cart, you must provide the cart ID, the ## Reference -The [`addSimpleProductsToCart`](/reference/graphql/latest/index.md#addsimpleproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addSimpleProductsToCart`](/reference/graphql/latest/mutations.md#addsimpleproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/add-virtual-products.md b/src/pages/graphql/schema/cart/mutations/add-virtual-products.md index 679643d45..9e58376b2 100644 --- a/src/pages/graphql/schema/cart/mutations/add-virtual-products.md +++ b/src/pages/graphql/schema/cart/mutations/add-virtual-products.md @@ -22,7 +22,7 @@ The `addVirtualProductsToCart` mutation allows you to add multiple virtual produ ## Reference -The [`addVirtualProductsToCart`](/reference/graphql/latest/index.md#addvirtualproductstocart) reference provides detailed information about the types and fields defined in this mutation. +The [`addVirtualProductsToCart`](/reference/graphql/latest/mutations.md#addvirtualproductstocart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-coupon.md b/src/pages/graphql/schema/cart/mutations/apply-coupon.md index 682738cab..e74c7c8e7 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-coupon.md +++ b/src/pages/graphql/schema/cart/mutations/apply-coupon.md @@ -15,9 +15,9 @@ The `applyCouponToCart` mutation applies a predefined coupon code to the specifi The `applyCouponToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applycoupontocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#applycoupontocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#applycoupontocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#applycoupontocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-coupons.md b/src/pages/graphql/schema/cart/mutations/apply-coupons.md index aca2116a9..a15f284ef 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-coupons.md +++ b/src/pages/graphql/schema/cart/mutations/apply-coupons.md @@ -19,9 +19,9 @@ The `type` field of the `ApplyCouponsToCartInput` object must be set to either ` The `applyCouponsToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applycouponstocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#applycouponstocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#applycouponstocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#applycouponstocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-giftcard.md b/src/pages/graphql/schema/cart/mutations/apply-giftcard.md index c1ecd889f..1a91fc67f 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-giftcard.md +++ b/src/pages/graphql/schema/cart/mutations/apply-giftcard.md @@ -17,9 +17,9 @@ The `applyGiftCardToCart` mutation applies a predefined gift card code to the sp The `applyGiftCardToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applygiftcardtocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#applygiftcardtocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#applygiftcardtocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#applygiftcardtocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-reward-points.md b/src/pages/graphql/schema/cart/mutations/apply-reward-points.md index c9184c495..1daf240da 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-reward-points.md +++ b/src/pages/graphql/schema/cart/mutations/apply-reward-points.md @@ -19,9 +19,9 @@ Use the [`removeRewardPointsFromCart` mutation](remove-reward-points.md) to undo The `applyRewardPointsToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applyrewardpointstocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#applyrewardpointstocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#applyrewardpointstocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#applyrewardpointstocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/apply-store-credit.md b/src/pages/graphql/schema/cart/mutations/apply-store-credit.md index c554cce2d..8ca1a7872 100644 --- a/src/pages/graphql/schema/cart/mutations/apply-store-credit.md +++ b/src/pages/graphql/schema/cart/mutations/apply-store-credit.md @@ -25,9 +25,9 @@ If the amount of available store credit equals or exceeds the grand total of the The `applyStoreCreditToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#applystorecredittocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#applystorecredittocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#applystorecredittocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#applystorecredittocart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md b/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md index 49e3029bf..ed57bb636 100644 --- a/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md +++ b/src/pages/graphql/schema/cart/mutations/assign-customer-to-guest-cart.md @@ -33,9 +33,9 @@ mutation { The `assignCustomerToGuestCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#assigncustomertoguestcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#assigncustomertoguestcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#assigncustomertoguestcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#assigncustomertoguestcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/clear-cart.md b/src/pages/graphql/schema/cart/mutations/clear-cart.md index 092982bd4..c3d72eeb2 100644 --- a/src/pages/graphql/schema/cart/mutations/clear-cart.md +++ b/src/pages/graphql/schema/cart/mutations/clear-cart.md @@ -24,7 +24,7 @@ mutation { ## Reference -The [`clearCart`](/reference/graphql/latest/index.md#clearcart) reference provides detailed information about the types and fields defined in this mutation. +The [`clearCart`](/reference/graphql/latest/mutations.md#clearcart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/create-empty-cart.md b/src/pages/graphql/schema/cart/mutations/create-empty-cart.md index 36db02227..3e50fa8bf 100644 --- a/src/pages/graphql/schema/cart/mutations/create-empty-cart.md +++ b/src/pages/graphql/schema/cart/mutations/create-empty-cart.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`createEmptyCart`](/reference/graphql/latest/index.md#createemptycart) reference provides detailed information about the types and fields defined in this mutation. +The [`createEmptyCart`](/reference/graphql/latest/mutations.md#createemptycart) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/create-guest-cart.md b/src/pages/graphql/schema/cart/mutations/create-guest-cart.md index 3282d580f..7c156dbfd 100644 --- a/src/pages/graphql/schema/cart/mutations/create-guest-cart.md +++ b/src/pages/graphql/schema/cart/mutations/create-guest-cart.md @@ -21,9 +21,9 @@ mutation { The `createGuestCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createguestcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createguestcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createguestcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createguestcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md b/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md index da26666a6..0dfb58096 100644 --- a/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md +++ b/src/pages/graphql/schema/cart/mutations/estimate-shipping-methods.md @@ -22,9 +22,9 @@ mutation { The `estimateShippingMethods` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#estimateshippingmethods) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#estimateshippingmethods) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#estimateshippingmethods) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#estimateshippingmethods) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/estimate-totals.md b/src/pages/graphql/schema/cart/mutations/estimate-totals.md index e43ca7492..a93692a19 100644 --- a/src/pages/graphql/schema/cart/mutations/estimate-totals.md +++ b/src/pages/graphql/schema/cart/mutations/estimate-totals.md @@ -22,9 +22,9 @@ mutation { The `estimateTotals` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#estimatetotals) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#estimatetotals) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#estimatetotals) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#estimatetotals) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/merge.md b/src/pages/graphql/schema/cart/mutations/merge.md index 22258ce1c..816f87f28 100644 --- a/src/pages/graphql/schema/cart/mutations/merge.md +++ b/src/pages/graphql/schema/cart/mutations/merge.md @@ -33,9 +33,9 @@ mutation { The `mergeCarts` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#mergecarts) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#mergecarts) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#mergecarts) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#mergecarts) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/place-order.md b/src/pages/graphql/schema/cart/mutations/place-order.md index 3cfd29fd6..b3178df10 100644 --- a/src/pages/graphql/schema/cart/mutations/place-order.md +++ b/src/pages/graphql/schema/cart/mutations/place-order.md @@ -41,9 +41,9 @@ mutation { The `placeOrder` reference provides detailed information about the types and fields defined in this mutation. -- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#placeorder) +- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#placeorder) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#placeorder) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/mutations.md#placeorder) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md b/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md index 0b5854a5f..ba4e40579 100644 --- a/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md +++ b/src/pages/graphql/schema/cart/mutations/redeem-giftcard-balance.md @@ -29,9 +29,9 @@ mutation { The `redeemGiftCardBalanceAsStoreCredit` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#redeemgiftcardbalanceasstorecredit) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#redeemgiftcardbalanceasstorecredit) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#redeemgiftcardbalanceasstorecredit) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#redeemgiftcardbalanceasstorecredit) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-coupon.md b/src/pages/graphql/schema/cart/mutations/remove-coupon.md index 96974dd92..22dbec3ef 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-coupon.md +++ b/src/pages/graphql/schema/cart/mutations/remove-coupon.md @@ -15,9 +15,9 @@ The `removeCouponFromCart` mutation removes a previously-applied coupon from the The `removeCouponFromCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removecouponfromcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removecouponfromcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removecouponfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removecouponfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-coupons.md b/src/pages/graphql/schema/cart/mutations/remove-coupons.md index b6ac6bd92..c89612f07 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-coupons.md +++ b/src/pages/graphql/schema/cart/mutations/remove-coupons.md @@ -17,9 +17,9 @@ The `removeCouponsFromCart` mutation removes previously-applied coupons from the The `removeCouponsFromCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removecouponsfromcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removecouponsfromcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removecouponsfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removecouponsfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-giftcard.md b/src/pages/graphql/schema/cart/mutations/remove-giftcard.md index 955182fb4..65eefc3da 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-giftcard.md +++ b/src/pages/graphql/schema/cart/mutations/remove-giftcard.md @@ -17,9 +17,9 @@ The `removeGiftCardFromCart` mutation removes a previously-applied gift card fro The `removeGiftCardFromCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftcardfromcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removegiftcardfromcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftcardfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removegiftcardfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-item.md b/src/pages/graphql/schema/cart/mutations/remove-item.md index d925d37a0..1ccfc9641 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-item.md +++ b/src/pages/graphql/schema/cart/mutations/remove-item.md @@ -15,9 +15,9 @@ The `removeItemFromCart` mutation deletes the entire quantity of a specified ite The `removeItemFromCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removeitemfromcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removeitemfromcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removeitemfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removeitemfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-reward-points.md b/src/pages/graphql/schema/cart/mutations/remove-reward-points.md index 25fd4cfbb..6934781fb 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-reward-points.md +++ b/src/pages/graphql/schema/cart/mutations/remove-reward-points.md @@ -17,9 +17,9 @@ The `removeRewardPointsFromCart` mutation removes all reward points that were pr The `removeRewardPointsFromCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removerewardpointsfromcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removerewardpointsfromcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removerewardpointsfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removerewardpointsfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/remove-store-credit.md b/src/pages/graphql/schema/cart/mutations/remove-store-credit.md index a018564d5..2b9ad7f0e 100644 --- a/src/pages/graphql/schema/cart/mutations/remove-store-credit.md +++ b/src/pages/graphql/schema/cart/mutations/remove-store-credit.md @@ -19,9 +19,9 @@ Store credit must be enabled on the store to run this mutation. The `removeStoreCreditFromCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removestorecreditfromcart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removestorecreditfromcart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removestorecreditfromcart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removestorecreditfromcart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-billing-address.md b/src/pages/graphql/schema/cart/mutations/set-billing-address.md index c153ebeeb..101595ae4 100644 --- a/src/pages/graphql/schema/cart/mutations/set-billing-address.md +++ b/src/pages/graphql/schema/cart/mutations/set-billing-address.md @@ -15,9 +15,9 @@ The `setBillingAddressOnCart` mutation sets the billing address for a specific c The `setBillingAddressOnCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setbillingaddressoncart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setbillingaddressoncart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setbillingaddressoncart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setbillingaddressoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-gift-options.md b/src/pages/graphql/schema/cart/mutations/set-gift-options.md index 9764e68a8..ac0647890 100644 --- a/src/pages/graphql/schema/cart/mutations/set-gift-options.md +++ b/src/pages/graphql/schema/cart/mutations/set-gift-options.md @@ -43,9 +43,9 @@ Gift wrapping is available for simple, configurable, bundle products as well as The `setGiftOptionsOnCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setgiftoptionsoncart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setgiftoptionsoncart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setgiftoptionsoncart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setgiftoptionsoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-guest-email.md b/src/pages/graphql/schema/cart/mutations/set-guest-email.md index b66c380ee..d8a667c4a 100644 --- a/src/pages/graphql/schema/cart/mutations/set-guest-email.md +++ b/src/pages/graphql/schema/cart/mutations/set-guest-email.md @@ -17,9 +17,9 @@ A logged-in customer specifies an email address when they create an account. The The `setGuestEmailOnCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setguestemailoncart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setguestemailoncart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setguestemailoncart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setguestemailoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-payment-method.md b/src/pages/graphql/schema/cart/mutations/set-payment-method.md index 7bc877452..3b44a8cc3 100644 --- a/src/pages/graphql/schema/cart/mutations/set-payment-method.md +++ b/src/pages/graphql/schema/cart/mutations/set-payment-method.md @@ -44,9 +44,9 @@ braintree: { The `setPaymentMethodOnCart` reference provides detailed information about the types and fields defined in this mutation. -- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setpaymentmethodoncart) +- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setpaymentmethodoncart) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#setpaymentmethodoncart) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setpaymentmethodoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md b/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md index e8fc954be..34c9e17e1 100644 --- a/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md +++ b/src/pages/graphql/schema/cart/mutations/set-payment-place-order.md @@ -42,7 +42,7 @@ mutation { ## Reference -The [`setPaymentMethodAndPlaceOrder`](/reference/graphql/latest/index.md#setpaymentmethodandplaceorder) reference provides detailed information about the types and fields defined in this mutation. +The [`setPaymentMethodAndPlaceOrder`](/reference/graphql/latest/mutations.md#setpaymentmethodandplaceorder) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-shipping-address.md b/src/pages/graphql/schema/cart/mutations/set-shipping-address.md index 3933ef403..c03c40241 100644 --- a/src/pages/graphql/schema/cart/mutations/set-shipping-address.md +++ b/src/pages/graphql/schema/cart/mutations/set-shipping-address.md @@ -18,9 +18,9 @@ The `setShippingAddressesOnCart` mutation sets one or more shipping addresses on The `setShippingAddressesOnCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setshippingaddressesoncart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setshippingaddressesoncart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setshippingaddressesoncart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setshippingaddressesoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/set-shipping-method.md b/src/pages/graphql/schema/cart/mutations/set-shipping-method.md index bc0913af3..86fb836da 100644 --- a/src/pages/graphql/schema/cart/mutations/set-shipping-method.md +++ b/src/pages/graphql/schema/cart/mutations/set-shipping-method.md @@ -29,9 +29,9 @@ Do not run the `setShippingMethodsOnCart` mutation on in-store pickup orders. In The `setShippingMethodsOnCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#setshippingmethodsoncart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#setshippingmethodsoncart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#setshippingmethodsoncart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#setshippingmethodsoncart) ## Example usage diff --git a/src/pages/graphql/schema/cart/mutations/update-items.md b/src/pages/graphql/schema/cart/mutations/update-items.md index 17618fb11..c986931e5 100644 --- a/src/pages/graphql/schema/cart/mutations/update-items.md +++ b/src/pages/graphql/schema/cart/mutations/update-items.md @@ -19,9 +19,9 @@ Setting the quantity to `0` removes an item from the cart. The `updateCartItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecartitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecartitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecartitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecartitems) ## Example usage diff --git a/src/pages/graphql/schema/cart/queries/cart.md b/src/pages/graphql/schema/cart/queries/cart.md index abba3dcec..b00e5dcb4 100644 --- a/src/pages/graphql/schema/cart/queries/cart.md +++ b/src/pages/graphql/schema/cart/queries/cart.md @@ -21,9 +21,9 @@ Cart functionality is defined in the `Quote` module. A Quote represents the cont The `cart` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#cart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#cart) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#cart) ## Sample queries @@ -612,7 +612,7 @@ The following query shows how to retrieve fixed product tax (FPT) information fo Note that fixed product tax information appears under `cart.items.prices.fixed_product_taxes` rather than in the `applied_taxes` section. The FPT amount is included in the `subtotal_including_tax` and `grand_total` values. -For more details about cart item prices and FPT fields in the schema, see the [CartItemPrices](/reference/graphql/latest/index.md#cartitemprices) reference. +For more details about cart item prices and FPT fields in the schema, see the [CartItemPrices](/reference/graphql/latest/types-c-e.md#cartitemprices) reference. ### Tier price example diff --git a/src/pages/graphql/schema/cart/queries/index.md b/src/pages/graphql/schema/cart/queries/index.md index ee2553848..48520c281 100644 --- a/src/pages/graphql/schema/cart/queries/index.md +++ b/src/pages/graphql/schema/cart/queries/index.md @@ -5,6 +5,6 @@ description: The cart query returns the content of the shopper's cart. Adobe Com # Cart queries -The [`cart`](cart.md) query returns the content of the shopper's cart. Adobe Commerce returns the [`Cart`](/reference/graphql/latest/index.md#cart) object. This object is also returned by numerous mutations, including those that add products to the cart and prepare a cart for checkout. +The [`cart`](cart.md) query returns the content of the shopper's cart. Adobe Commerce returns the [`Cart`](/reference/graphql/latest/types-c-e.md#cart) object. This object is also returned by numerous mutations, including those that add products to the cart and prepare a cart for checkout. When Inventory Management is installed and configured, you can use the [`pickupLocations`](pickup-locations.md) query to help a shopper determine whether their order can be picked up at a physical location. This query is most useful when the shopper has selected one or more items for purchase. diff --git a/src/pages/graphql/schema/cart/queries/pickup-locations.md b/src/pages/graphql/schema/cart/queries/pickup-locations.md index fd4acb07f..a695d8738 100644 --- a/src/pages/graphql/schema/cart/queries/pickup-locations.md +++ b/src/pages/graphql/schema/cart/queries/pickup-locations.md @@ -37,9 +37,9 @@ pickupLocations (area: AreaInput filters: PickupLocationFilterInput sort: Pickup The `pickupLocations` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#pickuplocations) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#pickuplocations) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#pickuplocations) +* [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#pickuplocations) ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md b/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md index b050a1883..a1c394073 100644 --- a/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md +++ b/src/pages/graphql/schema/checkout/mutations/create-braintree-client-token.md @@ -20,7 +20,7 @@ mutation { ## Reference -The [`createBraintreeClientToken`](/reference/graphql/latest/index.md#createbraintreeclienttoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createBraintreeClientToken`](/reference/graphql/latest/mutations.md#createbraintreeclienttoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md b/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md index 8887dae7d..4b196f47a 100644 --- a/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md +++ b/src/pages/graphql/schema/checkout/mutations/create-payflow-pro-token.md @@ -30,7 +30,7 @@ mutation { ## Reference -The [`createPayflowProToken`](/reference/graphql/latest/index.md#createpayflowprotoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createPayflowProToken`](/reference/graphql/latest/mutations.md#createpayflowprotoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md b/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md index 06841ab77..3924960fa 100644 --- a/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md +++ b/src/pages/graphql/schema/checkout/mutations/create-paypal-express-token.md @@ -32,7 +32,7 @@ mutation { ## Reference -The [`createPaypalExpressToken`](/reference/graphql/latest/index.md#createpaypalexpresstoken) reference provides detailed information about the types and fields defined in this mutation. +The [`createPaypalExpressToken`](/reference/graphql/latest/mutations.md#createpaypalexpresstoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md b/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md index 523abe0b0..a5b69600e 100644 --- a/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md +++ b/src/pages/graphql/schema/checkout/mutations/delete-payment-token.md @@ -27,9 +27,9 @@ mutation { The `deletePaymentToken` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletepaymenttoken) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletepaymenttoken) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletepaymenttoken) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletepaymenttoken) ## Example usage diff --git a/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md b/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md index 0c644f830..5eee03c84 100644 --- a/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md +++ b/src/pages/graphql/schema/checkout/mutations/handle-payflow-pro-response.md @@ -31,7 +31,7 @@ See [PayPal Payflow Pro payment method](../../../payment-methods/payflow-pro.md) ## Reference -The [`handlePayflowProResponse`](/reference/graphql/latest/index.md#handlepayflowproresponse) reference provides detailed information about the types and fields defined in this mutation. +The [`handlePayflowProResponse`](/reference/graphql/latest/mutations.md#handlepayflowproresponse) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md b/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md index add900677..6ec7bf494 100644 --- a/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md +++ b/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md @@ -21,9 +21,9 @@ You must specify the customer's authorization token in the header of the call. The `customerPaymentTokens` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customerpaymenttokens) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#customerpaymenttokens) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#customerpaymenttokens) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#customerpaymenttokens) ## Example usage diff --git a/src/pages/graphql/schema/customer/index.md b/src/pages/graphql/schema/customer/index.md index eeacc36cf..174b5075c 100644 --- a/src/pages/graphql/schema/customer/index.md +++ b/src/pages/graphql/schema/customer/index.md @@ -9,7 +9,7 @@ A customer is a shopper who has created an account for the store. To return or modify information about a customer, we recommend you use [customer tokens](../../usage/authorization-tokens.md) in the header of your GraphQL calls. However, you also can use [session authentication](/get-started/authentication/gs-authentication-session.md). -B2B for Adobe Commerce adds the following top-level fields to the [`Customer`](/reference/graphql/latest/index.md#customer) object for company administrators and users. +B2B for Adobe Commerce adds the following top-level fields to the [`Customer`](/reference/graphql/latest/types-c-e.md#customer) object for company administrators and users. * `job_title` * `requisition_lists` diff --git a/src/pages/graphql/schema/customer/mutations/assign-compare-list.md b/src/pages/graphql/schema/customer/mutations/assign-compare-list.md index 3bb543b1a..9bf6a4957 100644 --- a/src/pages/graphql/schema/customer/mutations/assign-compare-list.md +++ b/src/pages/graphql/schema/customer/mutations/assign-compare-list.md @@ -25,9 +25,9 @@ mutation { The `assignCompareListToCustomer` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#assigncomparelisttocustomer) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#assigncomparelisttocustomer) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#assigncomparelisttocustomer) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#assigncomparelisttocustomer) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/change-password.md b/src/pages/graphql/schema/customer/mutations/change-password.md index 81a597375..f0ad2443c 100644 --- a/src/pages/graphql/schema/customer/mutations/change-password.md +++ b/src/pages/graphql/schema/customer/mutations/change-password.md @@ -17,9 +17,9 @@ To return or modify information about a customer, we recommend you use customer The `changeCustomerPassword` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#changecustomerpassword) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#changecustomerpassword) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#changecustomerpassword) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#changecustomerpassword) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/confirm-email.md b/src/pages/graphql/schema/customer/mutations/confirm-email.md index 068da19a0..8bf087f0a 100644 --- a/src/pages/graphql/schema/customer/mutations/confirm-email.md +++ b/src/pages/graphql/schema/customer/mutations/confirm-email.md @@ -15,9 +15,9 @@ The `confirmEmail` mutation completes the customer activation process by confirm The `confirmEmail` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#confirmemail) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#confirmemail) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#confirmemail) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#confirmemail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/create-address.md b/src/pages/graphql/schema/customer/mutations/create-address.md index 39700aecb..3adb33a96 100644 --- a/src/pages/graphql/schema/customer/mutations/create-address.md +++ b/src/pages/graphql/schema/customer/mutations/create-address.md @@ -17,9 +17,9 @@ To return or modify information about a customer, we recommend you use customer The `createCustomerAddress` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcustomeraddress) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcustomeraddress) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcustomeraddress) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcustomeraddress) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/create-v2.md b/src/pages/graphql/schema/customer/mutations/create-v2.md index 10af06e7f..f3ae3a225 100644 --- a/src/pages/graphql/schema/customer/mutations/create-v2.md +++ b/src/pages/graphql/schema/customer/mutations/create-v2.md @@ -21,9 +21,9 @@ As of version 2.4.7, you can use the `custom_attributes` field to define an arra The `createCustomerV2` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcustomerv2) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcustomerv2) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcustomerv2) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcustomerv2) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/create.md b/src/pages/graphql/schema/customer/mutations/create.md index 9412da9b7..0f127fa7c 100644 --- a/src/pages/graphql/schema/customer/mutations/create.md +++ b/src/pages/graphql/schema/customer/mutations/create.md @@ -24,7 +24,7 @@ To return or modify information about a customer, we recommend you use customer ## Reference -The [`createCustomer`](/reference/graphql/latest/index.md#createcustomer) reference provides detailed information about the types and fields defined in this mutation. +The [`createCustomer`](/reference/graphql/latest/mutations.md#createcustomer) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/delete-address-v2.md b/src/pages/graphql/schema/customer/mutations/delete-address-v2.md index 41f8c4b98..e4db3bcb9 100644 --- a/src/pages/graphql/schema/customer/mutations/delete-address-v2.md +++ b/src/pages/graphql/schema/customer/mutations/delete-address-v2.md @@ -32,7 +32,7 @@ mutation { The `deleteCustomerAddressV2` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecustomeraddressv2) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletecustomeraddressv2) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/delete-address.md b/src/pages/graphql/schema/customer/mutations/delete-address.md index bdb3e3b1d..66e436b03 100644 --- a/src/pages/graphql/schema/customer/mutations/delete-address.md +++ b/src/pages/graphql/schema/customer/mutations/delete-address.md @@ -29,9 +29,9 @@ mutation { The `deleteCustomerAddress` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecustomeraddress) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletecustomeraddress) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecustomeraddress) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletecustomeraddress) ## Example usage 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 index 26a14d120..d17e2bdb9 100644 --- a/src/pages/graphql/schema/customer/mutations/exchange-otp-customer-token.md +++ b/src/pages/graphql/schema/customer/mutations/exchange-otp-customer-token.md @@ -19,7 +19,7 @@ Upon successful exchange, the module invalidates the OTP so it cannot be reused. ## Reference -The [`exchangeOtpForCustomerToken`](/reference/graphql/saas/index.md#exchangeotpforcustomertoken) reference provides detailed information about the types and fields defined in this mutation. +The [`exchangeOtpForCustomerToken`](/reference/graphql/saas/mutations.md#exchangeotpforcustomertoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md b/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md index 889f7e85b..ef7a9e2e1 100644 --- a/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md +++ b/src/pages/graphql/schema/customer/mutations/generate-token-as-admin.md @@ -19,9 +19,9 @@ mutation {generateCustomerTokenAsAdmin(input: GenerateCustomerTokenAsAdminInput! The `generateCustomerTokenAsAdmin` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#generatecustomertokenasadmin) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#generatecustomertokenasadmin) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#generatecustomertokenasadmin) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#generatecustomertokenasadmin) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/generate-token.md b/src/pages/graphql/schema/customer/mutations/generate-token.md index 0257a9810..61f7e62a5 100644 --- a/src/pages/graphql/schema/customer/mutations/generate-token.md +++ b/src/pages/graphql/schema/customer/mutations/generate-token.md @@ -57,7 +57,7 @@ mutation { ## Reference -The [`generateCustomerToken`](/reference/graphql/latest/index.md#generatecustomertoken) reference provides detailed information about the types and fields defined in this mutation. +The [`generateCustomerToken`](/reference/graphql/latest/mutations.md#generatecustomertoken) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md b/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md index a824da194..159eefe2a 100644 --- a/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md +++ b/src/pages/graphql/schema/customer/mutations/request-password-reset-email.md @@ -34,9 +34,9 @@ Use the value of the token in the `resetPassword` mutation. The `requestPasswordResetEmail` reference provides detailed information about the types and fields defined in this mutation. -- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestpasswordresetemail) +- [SaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#requestpasswordresetemail) -- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/index.md#requestpasswordresetemail) +- [PaaS only](https://experienceleague.adobe.com/en/docs/commerce/user-guides/product-solutions) [On-Premises/Cloud](/reference/graphql/latest/mutations.md#requestpasswordresetemail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md b/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md index b70a9118e..a8b6c257b 100644 --- a/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md +++ b/src/pages/graphql/schema/customer/mutations/resend-confirmation-email.md @@ -17,9 +17,9 @@ The mutation returns `true` if the request was successful. Otherwise, it returns The `resendConfirmationEmail` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#resendconfirmationemail) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#resendconfirmationemail) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#resendconfirmationemail) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#resendconfirmationemail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/reset-password.md b/src/pages/graphql/schema/customer/mutations/reset-password.md index 222e8b324..890385586 100644 --- a/src/pages/graphql/schema/customer/mutations/reset-password.md +++ b/src/pages/graphql/schema/customer/mutations/reset-password.md @@ -23,9 +23,9 @@ The reset password token value can also be found in the `customer_entity`.`rp_to The `resetPassword` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#resetpassword) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#resetpassword) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#resetpassword) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#resetpassword) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/revoke-token.md b/src/pages/graphql/schema/customer/mutations/revoke-token.md index 6601af9b4..5244a4fd5 100644 --- a/src/pages/graphql/schema/customer/mutations/revoke-token.md +++ b/src/pages/graphql/schema/customer/mutations/revoke-token.md @@ -23,9 +23,9 @@ mutation { The `revokeCustomerToken` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#revokecustomertoken) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#revokecustomertoken) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#revokecustomertoken) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#revokecustomertoken) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md b/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md index 5b8d4da4c..7e1e3169e 100644 --- a/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md +++ b/src/pages/graphql/schema/customer/mutations/send-email-to-friend.md @@ -28,7 +28,7 @@ mutation { ## Reference -The [`sendEmailToFriend`](/reference/graphql/latest/index.md#sendemailtofriend) reference provides detailed information about the types and fields defined in this mutation. +The [`sendEmailToFriend`](/reference/graphql/latest/mutations.md#sendemailtofriend) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md b/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md index 11d7f461c..fe154360d 100644 --- a/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md +++ b/src/pages/graphql/schema/customer/mutations/subscribe-email-to-newsletter.md @@ -15,9 +15,9 @@ The `subscribeEmailToNewsletter` mutation allows guests and registered customers The `subscribeEmailToNewsletter` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#subscribeemailtonewsletter) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#subscribeemailtonewsletter) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#subscribeemailtonewsletter) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#subscribeemailtonewsletter) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-address-v2.md b/src/pages/graphql/schema/customer/mutations/update-address-v2.md index 02d8abebb..3399a9518 100644 --- a/src/pages/graphql/schema/customer/mutations/update-address-v2.md +++ b/src/pages/graphql/schema/customer/mutations/update-address-v2.md @@ -33,7 +33,7 @@ mutation { The `updateCustomerAddressV2` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomeraddressv2) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecustomeraddressv2) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-address.md b/src/pages/graphql/schema/customer/mutations/update-address.md index 987894769..6c3925c81 100644 --- a/src/pages/graphql/schema/customer/mutations/update-address.md +++ b/src/pages/graphql/schema/customer/mutations/update-address.md @@ -21,9 +21,9 @@ To return or modify information about a customer, we recommend you use customer The `updateCustomerAddress` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomeraddress) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecustomeraddress) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecustomeraddress) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecustomeraddress) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-email.md b/src/pages/graphql/schema/customer/mutations/update-email.md index fa66f568d..ea996ffa2 100644 --- a/src/pages/graphql/schema/customer/mutations/update-email.md +++ b/src/pages/graphql/schema/customer/mutations/update-email.md @@ -17,9 +17,9 @@ To return or modify information about a customer, we recommend you use customer The `updateCustomerEmail` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomeremail) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecustomeremail) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecustomeremail) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecustomeremail) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update-v2.md b/src/pages/graphql/schema/customer/mutations/update-v2.md index 289eb9be1..a1758803c 100644 --- a/src/pages/graphql/schema/customer/mutations/update-v2.md +++ b/src/pages/graphql/schema/customer/mutations/update-v2.md @@ -23,9 +23,9 @@ As of version 2.4.7, you can use the `custom_attributes` field to define an arra The `updateCustomerV2` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatecustomerv2) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatecustomerv2) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatecustomerv2) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatecustomerv2) ## Example usage diff --git a/src/pages/graphql/schema/customer/mutations/update.md b/src/pages/graphql/schema/customer/mutations/update.md index ce3d600dc..7390f9a70 100644 --- a/src/pages/graphql/schema/customer/mutations/update.md +++ b/src/pages/graphql/schema/customer/mutations/update.md @@ -22,7 +22,7 @@ To return or modify information about a customer, we recommend you use customer ## Reference -The [`updateCustomer`](/reference/graphql/latest/index.md#updatecustomer) reference provides detailed information about the types and fields defined in this mutation. +The [`updateCustomer`](/reference/graphql/latest/mutations.md#updatecustomer) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/customer.md b/src/pages/graphql/schema/customer/queries/customer.md index 3289acbd8..32678670a 100644 --- a/src/pages/graphql/schema/customer/queries/customer.md +++ b/src/pages/graphql/schema/customer/queries/customer.md @@ -17,9 +17,9 @@ To retrieve information about a customer, we recommend you use customer tokens i The `customer` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customer) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#customer) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#customer) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#customer) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/downloadable-products.md b/src/pages/graphql/schema/customer/queries/downloadable-products.md index c3f8fec91..ada93b16f 100644 --- a/src/pages/graphql/schema/customer/queries/downloadable-products.md +++ b/src/pages/graphql/schema/customer/queries/downloadable-products.md @@ -16,7 +16,7 @@ Use the `customerDownloadableProducts` query to retrieve the list of purchased d ## Reference -The [`customerDownloadableProducts`](/reference/graphql/latest/index.md#customerdownloadableproducts) reference provides detailed information about the types and fields defined in this query. +The [`customerDownloadableProducts`](/reference/graphql/latest/types-c-e.md#customerdownloadableproducts) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/giftcard-account.md b/src/pages/graphql/schema/customer/queries/giftcard-account.md index f2c7c1111..26278e469 100644 --- a/src/pages/graphql/schema/customer/queries/giftcard-account.md +++ b/src/pages/graphql/schema/customer/queries/giftcard-account.md @@ -17,9 +17,9 @@ The `giftCardAccount` query returns information for a specific gift card. The `giftCardAccount` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftcardaccount) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-f-i.md#giftcardaccount) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftcardaccount) +* [On-Premises/Cloud](/reference/graphql/latest/types-f-i.md#giftcardaccount) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/orders.md b/src/pages/graphql/schema/customer/queries/orders.md index d7fae077e..97a41756c 100644 --- a/src/pages/graphql/schema/customer/queries/orders.md +++ b/src/pages/graphql/schema/customer/queries/orders.md @@ -22,7 +22,7 @@ We recommend you use customer tokens in the header of your GraphQL calls. Howeve ## Reference -The [`customerOrders`](/reference/graphql/latest/index.md#customerorders) reference provides detailed information about the types and fields defined in this query. +The [`customerOrders`](/reference/graphql/latest/types-c-e.md#customerorders) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md b/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md index 767b53cd6..a56c9b5d1 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md +++ b/src/pages/graphql/schema/gift-registry/mutations/add-registrants.md @@ -28,9 +28,9 @@ mutation { The `addGiftRegistryRegistrants` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addgiftregistryregistrants) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addgiftregistryregistrants) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addgiftregistryregistrants) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addgiftregistryregistrants) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/create.md b/src/pages/graphql/schema/gift-registry/mutations/create.md index 2228d9a34..db71e71d1 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/create.md +++ b/src/pages/graphql/schema/gift-registry/mutations/create.md @@ -40,9 +40,9 @@ mutation { The `createGiftRegistry` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#creategiftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#creategiftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#creategiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#creategiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md b/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md index c0f122cc3..05b16d8f7 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md +++ b/src/pages/graphql/schema/gift-registry/mutations/move-cart-items.md @@ -28,9 +28,9 @@ mutation { The `moveCartItemsToGiftRegistry` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#movecartitemstogiftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#movecartitemstogiftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#movecartitemstogiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#movecartitemstogiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/remove-items.md b/src/pages/graphql/schema/gift-registry/mutations/remove-items.md index 430c7b316..201e6559e 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/remove-items.md +++ b/src/pages/graphql/schema/gift-registry/mutations/remove-items.md @@ -28,9 +28,9 @@ mutation { The `removeGiftRegistryItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftregistryitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removegiftregistryitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftregistryitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removegiftregistryitems) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md b/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md index 23426b2df..f94bac224 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md +++ b/src/pages/graphql/schema/gift-registry/mutations/remove-registrants.md @@ -28,9 +28,9 @@ mutation { The `removeGiftRegistryRegistrants` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftregistryregistrants) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removegiftregistryregistrants) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftregistryregistrants) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removegiftregistryregistrants) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/remove.md b/src/pages/graphql/schema/gift-registry/mutations/remove.md index 61edad4bb..95af61ee6 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/remove.md +++ b/src/pages/graphql/schema/gift-registry/mutations/remove.md @@ -21,9 +21,9 @@ removeGiftRegistry ( giftRegistryUid ID! ) RemoveGiftRegistryOutput The `removeGiftRegistry` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removegiftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removegiftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removegiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removegiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/share.md b/src/pages/graphql/schema/gift-registry/mutations/share.md index 07a171df2..5e53a1640 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/share.md +++ b/src/pages/graphql/schema/gift-registry/mutations/share.md @@ -29,9 +29,9 @@ mutation { The `shareGiftRegistry` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#sharegiftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#sharegiftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#sharegiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#sharegiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/update-items.md b/src/pages/graphql/schema/gift-registry/mutations/update-items.md index 1c6c6fa26..bcb78114d 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/update-items.md +++ b/src/pages/graphql/schema/gift-registry/mutations/update-items.md @@ -28,9 +28,9 @@ mutation { The `updateGiftRegistryItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updategiftregistryitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updategiftregistryitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updategiftregistryitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updategiftregistryitems) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md b/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md index e6fa9edca..b92609581 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md +++ b/src/pages/graphql/schema/gift-registry/mutations/update-registrants.md @@ -28,9 +28,9 @@ mutation { The `updateGiftRegistryRegistrants` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updategiftregistryregistrants) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updategiftregistryregistrants) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updategiftregistryregistrants) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updategiftregistryregistrants) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/mutations/update.md b/src/pages/graphql/schema/gift-registry/mutations/update.md index 41933bfb8..a154429f1 100644 --- a/src/pages/graphql/schema/gift-registry/mutations/update.md +++ b/src/pages/graphql/schema/gift-registry/mutations/update.md @@ -30,9 +30,9 @@ mutation { The `updateGiftRegistry` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updategiftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updategiftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updategiftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updategiftregistry) ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/gift-registry.md b/src/pages/graphql/schema/gift-registry/queries/gift-registry.md index a69759d96..eaca99187 100644 --- a/src/pages/graphql/schema/gift-registry/queries/gift-registry.md +++ b/src/pages/graphql/schema/gift-registry/queries/gift-registry.md @@ -21,9 +21,9 @@ giftRegistry(uid: ID!): GiftRegistry The `giftRegistry` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-f-i.md#giftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/types-f-i.md#giftregistry) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md b/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md index d19a592cd..a2330a0d8 100644 --- a/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md +++ b/src/pages/graphql/schema/orders/interfaces/credit-memo-item.md @@ -16,9 +16,9 @@ description: CreditMemoItemInterface provides details about items in a customer' The `CreditMemoItemInterface` reference provides detailed information about the types and fields defined in this interface. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#creditmemoiteminterface) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#creditmemoiteminterface) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#creditmemoiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#creditmemoiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/invoice-item.md b/src/pages/graphql/schema/orders/interfaces/invoice-item.md index 2d233de45..375acf520 100644 --- a/src/pages/graphql/schema/orders/interfaces/invoice-item.md +++ b/src/pages/graphql/schema/orders/interfaces/invoice-item.md @@ -16,9 +16,9 @@ description: InvoiceItemInterface provides details about items in a customer's o The `InvoiceItemInterface` reference provides detailed information about the types and fields defined in this interface. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#invoiceiteminterface) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-f-i.md#invoiceiteminterface) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#invoiceiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/types-f-i.md#invoiceiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/order-item.md b/src/pages/graphql/schema/orders/interfaces/order-item.md index adf07d0de..5e0ae8534 100644 --- a/src/pages/graphql/schema/orders/interfaces/order-item.md +++ b/src/pages/graphql/schema/orders/interfaces/order-item.md @@ -16,9 +16,9 @@ description: OrderItemInterface provides details about items in a customer's ord The `OrderItemInterface` reference provides detailed information about the types and fields defined in this interface. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#orderiteminterface) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#orderiteminterface) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#orderiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#orderiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/interfaces/shipment-item.md b/src/pages/graphql/schema/orders/interfaces/shipment-item.md index 1c6e1b470..76f8d0bd2 100644 --- a/src/pages/graphql/schema/orders/interfaces/shipment-item.md +++ b/src/pages/graphql/schema/orders/interfaces/shipment-item.md @@ -15,9 +15,9 @@ description: ShipmentItemInterface provides details about items in a customer's The `ShipmentItemInterface` reference provides detailed information about the types and fields defined in this interface. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#shipmentiteminterface) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-q-s.md#shipmentiteminterface) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#shipmentiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/types-q-s.md#shipmentiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/add-return-comment.md b/src/pages/graphql/schema/orders/mutations/add-return-comment.md index 2f7b744c9..b11a53762 100644 --- a/src/pages/graphql/schema/orders/mutations/add-return-comment.md +++ b/src/pages/graphql/schema/orders/mutations/add-return-comment.md @@ -19,9 +19,9 @@ mutation: { The `addReturnComment` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addreturncomment) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addreturncomment) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addreturncomment) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addreturncomment) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/add-return-tracking.md b/src/pages/graphql/schema/orders/mutations/add-return-tracking.md index 4584c7f9d..973a36132 100644 --- a/src/pages/graphql/schema/orders/mutations/add-return-tracking.md +++ b/src/pages/graphql/schema/orders/mutations/add-return-tracking.md @@ -19,9 +19,9 @@ mutation: { The `addReturnTracking` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addreturntracking) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addreturntracking) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addreturntracking) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addreturntracking) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/cancel-order.md b/src/pages/graphql/schema/orders/mutations/cancel-order.md index ccd805934..cad002bae 100644 --- a/src/pages/graphql/schema/orders/mutations/cancel-order.md +++ b/src/pages/graphql/schema/orders/mutations/cancel-order.md @@ -25,9 +25,9 @@ The mutation returns an error if the order cannot be cancelled. The `cancelOrder` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cancelorder) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#cancelorder) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#cancelorder) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#cancelorder) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md b/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md index d4e8cf535..60d82dd7b 100644 --- a/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md +++ b/src/pages/graphql/schema/orders/mutations/confirm-cancel-order.md @@ -25,9 +25,9 @@ The mutation returns an error if the order cannot be cancelled. The `confirmCancelOrder` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#confirmcancelorder) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#confirmcancelorder) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#confirmcancelorder) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#confirmcancelorder) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/confirm-return.md b/src/pages/graphql/schema/orders/mutations/confirm-return.md index 4ac5e4142..77d60f0b5 100644 --- a/src/pages/graphql/schema/orders/mutations/confirm-return.md +++ b/src/pages/graphql/schema/orders/mutations/confirm-return.md @@ -21,9 +21,9 @@ mutation { The `confirmReturn` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#confirmreturn) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#confirmreturn) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#confirmreturn) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#confirmreturn) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md b/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md index e575f10df..e586b2d42 100644 --- a/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md +++ b/src/pages/graphql/schema/orders/mutations/remove-return-tracking.md @@ -19,9 +19,9 @@ mutation: { The `removeReturnTracking` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removereturntracking) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removereturntracking) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removereturntracking) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removereturntracking) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/reorder-items.md b/src/pages/graphql/schema/orders/mutations/reorder-items.md index fb509bc25..39ffdae86 100644 --- a/src/pages/graphql/schema/orders/mutations/reorder-items.md +++ b/src/pages/graphql/schema/orders/mutations/reorder-items.md @@ -27,9 +27,9 @@ The `reorderItems` mutation will not add any products to the cart if it encounte The `reorderItems` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#reorderitems) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#reorderitems) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#reorderitems) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#reorderitems) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md b/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md index 8167e34c9..3ee5b2663 100644 --- a/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md +++ b/src/pages/graphql/schema/orders/mutations/request-guest-order-cancel.md @@ -23,9 +23,9 @@ The mutation returns an error if the order cannot be cancelled. The `requestGuestOrderCancel` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestguestordercancel) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#requestguestordercancel) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestguestordercancel) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#requestguestordercancel) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/request-guest-return.md b/src/pages/graphql/schema/orders/mutations/request-guest-return.md index 080045eed..6bcc50098 100644 --- a/src/pages/graphql/schema/orders/mutations/request-guest-return.md +++ b/src/pages/graphql/schema/orders/mutations/request-guest-return.md @@ -31,9 +31,9 @@ mutation { The `requestGuestReturn` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestguestreturn) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#requestguestreturn) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestguestreturn) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#requestguestreturn) ## Example usage diff --git a/src/pages/graphql/schema/orders/mutations/request-return.md b/src/pages/graphql/schema/orders/mutations/request-return.md index f552fcd50..f7d8edead 100644 --- a/src/pages/graphql/schema/orders/mutations/request-return.md +++ b/src/pages/graphql/schema/orders/mutations/request-return.md @@ -30,9 +30,9 @@ mutation { The `requestReturn` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#requestreturn) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#requestreturn) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#requestreturn) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#requestreturn) ## Example usage diff --git a/src/pages/graphql/schema/products/interfaces/attributes.md b/src/pages/graphql/schema/products/interfaces/attributes.md index a8e2140a3..d2c9daacf 100644 --- a/src/pages/graphql/schema/products/interfaces/attributes.md +++ b/src/pages/graphql/schema/products/interfaces/attributes.md @@ -5,11 +5,11 @@ description: Any type that implements ProductInterface contains all the base att # ProductInterface attributes -Any type that implements [`ProductInterface`](/reference/graphql/latest/index.md#productinterface) contains all the base attributes necessary for the frontend of the product model. +Any type that implements [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) contains all the base attributes necessary for the frontend of the product model. The `items` that are returned in a `ProductInterface` array can also contain attributes from resources external to the `CatalogGraphQl` module: - Custom and extension attributes defined in any attribute set -- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) +- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) - Product types that define their own implementation of `ProductInterface` including: - [SimpleProduct](types/simple.md) - [BundleProduct](types/bundle.md) diff --git a/src/pages/graphql/schema/products/interfaces/category.md b/src/pages/graphql/schema/products/interfaces/category.md index 8a3366745..7184fcd65 100644 --- a/src/pages/graphql/schema/products/interfaces/category.md +++ b/src/pages/graphql/schema/products/interfaces/category.md @@ -5,4 +5,4 @@ description: CategoryInterface defines attributes that can be returned in the ca # CategoryInterface attributes -[`CategoryInterface`](/reference/graphql/latest/index.md#categoryinterface) defines attributes that can be returned in the [`categoryList` query](../queries/category-list.md), [`categories` query](../queries/categories.md), and the [`products` query](../queries/products.md). +[`CategoryInterface`](/reference/graphql/latest/types-c-e.md#categoryinterface) defines attributes that can be returned in the [`categoryList` query](../queries/category-list.md), [`categories` query](../queries/categories.md), and the [`products` query](../queries/products.md). diff --git a/src/pages/graphql/schema/products/interfaces/customizable-option.md b/src/pages/graphql/schema/products/interfaces/customizable-option.md index c4b9bef3d..db9514a6b 100644 --- a/src/pages/graphql/schema/products/interfaces/customizable-option.md +++ b/src/pages/graphql/schema/products/interfaces/customizable-option.md @@ -7,7 +7,7 @@ description: Customizable options for a product provide a way to offer customers Customizable options for a product provide a way to offer customers a selection of options with a variety of text, selection, and date input types. All product types can contain customizable options. -[`CustomizableOptionInterface`](/reference/graphql/latest/index.md#customizableoptioninterface) is defined in the `CatalogGraphQl` module, and its attributes can be used in any `products` query. This interface returns basic information about a customizable option and can be implemented by several types of configurable options: +[`CustomizableOptionInterface`](/reference/graphql/latest/types-c-e.md#customizableoptioninterface) is defined in the `CatalogGraphQl` module, and its attributes can be used in any `products` query. This interface returns basic information about a customizable option and can be implemented by several types of configurable options: * Text area * Checkbox diff --git a/src/pages/graphql/schema/products/interfaces/index.md b/src/pages/graphql/schema/products/interfaces/index.md index b59c13abc..c38761fdc 100644 --- a/src/pages/graphql/schema/products/interfaces/index.md +++ b/src/pages/graphql/schema/products/interfaces/index.md @@ -5,11 +5,11 @@ description: Any type that implements ProductInterface contains all the base att # Product interfaces and attributes -Any type that implements [`ProductInterface`](/reference/graphql/latest/index.md#productinterface) contains all the base attributes necessary for the frontend of the product model. +Any type that implements [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) contains all the base attributes necessary for the frontend of the product model. The `items` that are returned in a `ProductInterface` array can also contain attributes from resources external to the `CatalogGraphQl` module: - Custom and extension attributes defined in any attribute set -- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) +- The attribute is defined in the [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface) or [CustomizableOptionInterface](customizable-option.md) - Product types that define their own implementation of `ProductInterface` including: - [`SimpleProduct`](types/simple.md) - [`BundleProduct`](types/bundle.md) diff --git a/src/pages/graphql/schema/products/interfaces/routable.md b/src/pages/graphql/schema/products/interfaces/routable.md index 29c8a56f5..205f69074 100644 --- a/src/pages/graphql/schema/products/interfaces/routable.md +++ b/src/pages/graphql/schema/products/interfaces/routable.md @@ -5,7 +5,7 @@ description: Some entities are "routable", meaning that they have URLs and can s # RoutableInterface attributes -Some entities are "routable", meaning that they have URLs and can serve as the model for a rendered page. The following implementations of the [`RoutableInterface`](/reference/graphql/latest/index.md#routableinterface) allow you to return details in the [`route` query](../queries/route.md). `RoutableUrl` is returned when the URL is not linked to an entity. +Some entities are "routable", meaning that they have URLs and can serve as the model for a rendered page. The following implementations of the [`RoutableInterface`](/reference/graphql/latest/types-q-s.md#routableinterface) allow you to return details in the [`route` query](../queries/route.md). `RoutableUrl` is returned when the URL is not linked to an entity. * [BundleProduct](types/bundle.md) * [CategoryTree](../queries/category-list.md#return-the-category-tree-of-a-top-level-category) diff --git a/src/pages/graphql/schema/products/interfaces/types/bundle.md b/src/pages/graphql/schema/products/interfaces/types/bundle.md index fa443b048..d03897325 100644 --- a/src/pages/graphql/schema/products/interfaces/types/bundle.md +++ b/src/pages/graphql/schema/products/interfaces/types/bundle.md @@ -5,12 +5,12 @@ description: The BundleProduct data type implements the following interfaces: # Bundle product data types -The [`BundleProduct`](/reference/graphql/latest/index.md#bundleproduct) data type implements the following interfaces: +The [`BundleProduct`](/reference/graphql/latest/types-a-b.md#bundleproduct) data type implements the following interfaces: -- [ProductInterface](/reference/graphql/latest/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/types-c-e.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface) Attributes that are specific to bundle products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/interfaces/types/configurable.md b/src/pages/graphql/schema/products/interfaces/types/configurable.md index 19a474da7..3b36aa96e 100644 --- a/src/pages/graphql/schema/products/interfaces/types/configurable.md +++ b/src/pages/graphql/schema/products/interfaces/types/configurable.md @@ -7,10 +7,10 @@ description: The ConfigurableProduct data type implements the following interfac The `ConfigurableProduct` data type implements the following interfaces: -- [ProductInterface](/reference/graphql/latest/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/types-c-e.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface) Attributes that are specific to configurable products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/interfaces/types/downloadable.md b/src/pages/graphql/schema/products/interfaces/types/downloadable.md index 862f3d216..14715c46a 100644 --- a/src/pages/graphql/schema/products/interfaces/types/downloadable.md +++ b/src/pages/graphql/schema/products/interfaces/types/downloadable.md @@ -5,7 +5,7 @@ description: The DownloadableProduct data type implements ProductInterface and C # Downloadable product data types -The `DownloadableProduct` data type implements [`ProductInterface`](/reference/graphql/latest/index.md#productinterface) and [`CustomizableProductInterface`](/reference/graphql/latest/index.md#customizableproductinterface). As a result, attributes that are specific to downloadable products can be used when performing a [`products`](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/latest/index.md#routableinterface). +The `DownloadableProduct` data type implements [`ProductInterface`](/reference/graphql/latest/types-k-p.md#productinterface) and [`CustomizableProductInterface`](/reference/graphql/latest/types-c-e.md#customizableproductinterface). As a result, attributes that are specific to downloadable products can be used when performing a [`products`](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface). ## Sample query diff --git a/src/pages/graphql/schema/products/interfaces/types/gift-card.md b/src/pages/graphql/schema/products/interfaces/types/gift-card.md index 8ff9d672f..4ec5430be 100644 --- a/src/pages/graphql/schema/products/interfaces/types/gift-card.md +++ b/src/pages/graphql/schema/products/interfaces/types/gift-card.md @@ -11,10 +11,10 @@ The `GiftCardProduct` data type defines properties of a gift card, including the It implements the following interfaces: -- [ProductInterface](/reference/graphql/latest/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/types-c-e.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface) ## Sample query diff --git a/src/pages/graphql/schema/products/interfaces/types/grouped.md b/src/pages/graphql/schema/products/interfaces/types/grouped.md index e81ad8b7c..b6c78e31e 100644 --- a/src/pages/graphql/schema/products/interfaces/types/grouped.md +++ b/src/pages/graphql/schema/products/interfaces/types/grouped.md @@ -5,7 +5,7 @@ description: The GroupedProduct data type implements ProductInterface and Physic # Grouped product data types -The `GroupedProduct` data type implements [ProductInterface](/reference/graphql/latest/index.md#productinterface) and [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface). As a result, attributes that are specific to grouped products can be used when performing a [products](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/latest/index.md#routableinterface). +The `GroupedProduct` data type implements [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface) and [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface). As a result, attributes that are specific to grouped products can be used when performing a [products](../../queries/products.md) query. It also implements [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface). ## Sample query diff --git a/src/pages/graphql/schema/products/interfaces/types/index.md b/src/pages/graphql/schema/products/interfaces/types/index.md index b1a231493..40a33e0dd 100644 --- a/src/pages/graphql/schema/products/interfaces/types/index.md +++ b/src/pages/graphql/schema/products/interfaces/types/index.md @@ -5,17 +5,17 @@ description: Adobe Commerce and Magento Open Source provides multiple product ty # Product interface implementations -Adobe Commerce and Magento Open Source provides multiple product types, and most of these product types have specialized attributes that are not defined in the [`ProductInterface`(/reference/graphql/latest/index.md#productinterface)]. +Adobe Commerce and Magento Open Source provides multiple product types, and most of these product types have specialized attributes that are not defined in the [`ProductInterface`(/reference/graphql/latest/types-k-p.md#productinterface)]. | Product type | Implements | Has product-specific attributes? | | --- | --- | --- | -| [BundleProduct](bundle.md) | ProductInterface, [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [ConfigurableProduct](configurable.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [DownloadableProduct](downloadable.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [GiftCardProduct](gift-card.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)| Yes | -| [GroupedProduct](grouped.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | -| [SimpleProduct](simple.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | -| [VirtualProduct](virtual.md) | [ProductInterface](/reference/graphql/latest/index.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | +| [BundleProduct](bundle.md) | ProductInterface, [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [ConfigurableProduct](configurable.md) | [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [DownloadableProduct](downloadable.md) | [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [GiftCardProduct](gift-card.md) | [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md)| Yes | +| [GroupedProduct](grouped.md) | [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | Yes | +| [SimpleProduct](simple.md) | [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | +| [VirtualProduct](virtual.md) | [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface), [CustomizableProductInterface](../customizable-option.md), [RoutableInterface](../routable.md) | No | ## Query for product-specific attributes diff --git a/src/pages/graphql/schema/products/interfaces/types/simple.md b/src/pages/graphql/schema/products/interfaces/types/simple.md index c32c5fdcd..ff2f7e2a7 100644 --- a/src/pages/graphql/schema/products/interfaces/types/simple.md +++ b/src/pages/graphql/schema/products/interfaces/types/simple.md @@ -7,10 +7,10 @@ description: The SimpleProduct data type implements the following interfaces: The `SimpleProduct` data type implements the following interfaces: -- [ProductInterface](/reference/graphql/latest/index.md#productinterface) -- [PhysicalProductInterface](/reference/graphql/latest/index.md#physicalproductinterface) -- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface) +- [PhysicalProductInterface](/reference/graphql/latest/types-k-p.md#physicalproductinterface) +- [CustomizableProductInterface](/reference/graphql/latest/types-c-e.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface) Attributes that are specific to the simple products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/interfaces/types/virtual.md b/src/pages/graphql/schema/products/interfaces/types/virtual.md index 1f437f9b8..84e48d63b 100644 --- a/src/pages/graphql/schema/products/interfaces/types/virtual.md +++ b/src/pages/graphql/schema/products/interfaces/types/virtual.md @@ -7,9 +7,9 @@ description: The VirtualProduct data type implements the following interfaces: The `VirtualProduct` data type implements the following interfaces: -- [ProductInterface](/reference/graphql/latest/index.md#productinterface) -- [CustomizableProductInterface](/reference/graphql/latest/index.md#customizableproductinterface) -- [RoutableInterface](/reference/graphql/latest/index.md#routableinterface) +- [ProductInterface](/reference/graphql/latest/types-k-p.md#productinterface) +- [CustomizableProductInterface](/reference/graphql/latest/types-c-e.md#customizableproductinterface) +- [RoutableInterface](/reference/graphql/latest/types-q-s.md#routableinterface) Attributes that are specific to the virtual products can be used when performing a [`products`](../../queries/products.md) query. diff --git a/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md b/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md index c4b561645..9a5152e10 100644 --- a/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/add-products-to-compare-list.md @@ -25,9 +25,9 @@ mutation { The `addProductsToCompareList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstocomparelist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addproductstocomparelist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstocomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addproductstocomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/assign-compare-list.md b/src/pages/graphql/schema/products/mutations/assign-compare-list.md index 6a5774301..e21c087c2 100644 --- a/src/pages/graphql/schema/products/mutations/assign-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/assign-compare-list.md @@ -25,9 +25,9 @@ mutation { The `assignCompareListToCustomer` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#assigncomparelisttocustomer) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#assigncomparelisttocustomer) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#assigncomparelisttocustomer) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#assigncomparelisttocustomer) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/create-compare-list.md b/src/pages/graphql/schema/products/mutations/create-compare-list.md index 464c3fab9..b7d014a0c 100644 --- a/src/pages/graphql/schema/products/mutations/create-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/create-compare-list.md @@ -25,9 +25,9 @@ mutation { The `createCompareList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createcomparelist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createcomparelist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createcomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createcomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/create-review.md b/src/pages/graphql/schema/products/mutations/create-review.md index 4fe6b0057..1543bb7f1 100644 --- a/src/pages/graphql/schema/products/mutations/create-review.md +++ b/src/pages/graphql/schema/products/mutations/create-review.md @@ -16,7 +16,7 @@ The `createProductReview` mutation adds a review for the specified product. Use ## Reference -The [`createProductReview`](/reference/graphql/latest/index.md#createproductreview) reference provides detailed information about the types and fields defined in this mutation. +The [`createProductReview`](/reference/graphql/latest/mutations.md#createproductreview) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/delete-compare-list.md b/src/pages/graphql/schema/products/mutations/delete-compare-list.md index 50582840d..148c33a9d 100644 --- a/src/pages/graphql/schema/products/mutations/delete-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/delete-compare-list.md @@ -26,9 +26,9 @@ mutation { The `deleteCompareList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletecomparelist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletecomparelist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletecomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletecomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md b/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md index 4a4edfc03..7d755a8de 100644 --- a/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md +++ b/src/pages/graphql/schema/products/mutations/remove-from-compare-list.md @@ -25,9 +25,9 @@ mutation { The `removeProductsFromCompareList` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removeproductsfromcomparelist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removeproductsfromcomparelist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removeproductsfromcomparelist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removeproductsfromcomparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/subscribe-product-alert-price.md b/src/pages/graphql/schema/products/mutations/subscribe-product-alert-price.md index 6ffd41192..3abef0dd8 100644 --- a/src/pages/graphql/schema/products/mutations/subscribe-product-alert-price.md +++ b/src/pages/graphql/schema/products/mutations/subscribe-product-alert-price.md @@ -24,7 +24,7 @@ mutation { ## Reference -The [`subscribeProductAlertPrice`](/reference/graphql/saas/index.md#subscribeproductalertprice) reference provides detailed information about the types and fields defined in this mutation. +The [`subscribeProductAlertPrice`](/reference/graphql/saas/mutations.md#subscribeproductalertprice) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/subscribe-product-alert-stock.md b/src/pages/graphql/schema/products/mutations/subscribe-product-alert-stock.md index 122e4a769..9132b6c84 100644 --- a/src/pages/graphql/schema/products/mutations/subscribe-product-alert-stock.md +++ b/src/pages/graphql/schema/products/mutations/subscribe-product-alert-stock.md @@ -24,7 +24,7 @@ mutation { ## Reference -The [`subscribeProductAlertStock`](/reference/graphql/saas/index.md#subscribeproductalertstock) reference provides detailed information about the types and fields defined in this mutation. +The [`subscribeProductAlertStock`](/reference/graphql/saas/mutations.md#subscribeproductalertstock) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price-all.md b/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price-all.md index 3e63ed85c..11eacad41 100644 --- a/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price-all.md +++ b/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price-all.md @@ -22,7 +22,7 @@ mutation { ## Reference -The [`unsubscribeProductAlertPriceAll`](/reference/graphql/saas/index.md#unsubscribeproductalertpriceall) reference provides detailed information about the types and fields defined in this mutation. +The [`unsubscribeProductAlertPriceAll`](/reference/graphql/saas/mutations.md#unsubscribeproductalertpriceall) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price.md b/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price.md index 5fb4972c2..f8480dbd5 100644 --- a/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price.md +++ b/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-price.md @@ -24,7 +24,7 @@ mutation { ## Reference -The [`unsubscribeProductAlertPrice`](/reference/graphql/saas/index.md#unsubscribeproductalertprice) reference provides detailed information about the types and fields defined in this mutation. +The [`unsubscribeProductAlertPrice`](/reference/graphql/saas/mutations.md#unsubscribeproductalertprice) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-stock-all.md b/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-stock-all.md index ba37dfaea..6bb1aa428 100644 --- a/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-stock-all.md +++ b/src/pages/graphql/schema/products/mutations/unsubscribe-product-alert-stock-all.md @@ -22,7 +22,7 @@ mutation { ## Reference -The [`unsubscribeProductAlertStockAll`](/reference/graphql/saas/index.md#unsubscribeproductalertstockall) reference provides detailed information about the types and fields defined in this mutation. +The [`unsubscribeProductAlertStockAll`](/reference/graphql/saas/mutations.md#unsubscribeproductalertstockall) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/compare-list.md b/src/pages/graphql/schema/products/queries/compare-list.md index a374aae85..a6c209453 100644 --- a/src/pages/graphql/schema/products/queries/compare-list.md +++ b/src/pages/graphql/schema/products/queries/compare-list.md @@ -19,9 +19,9 @@ compareList( The `compareList` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#comparelist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#comparelist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#comparelist) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#comparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md b/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md index dd359b29b..07944d06a 100644 --- a/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md +++ b/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md @@ -18,7 +18,7 @@ Use the [`createProductReview` mutation](../mutations/create-review.md) to add a ## Reference -The [`productReviewRatingsMetadata`](/reference/graphql/latest/index.md#productreviewratingsmetadata) reference provides detailed information about the types and fields defined in this query. +The [`productReviewRatingsMetadata`](/reference/graphql/latest/types-k-p.md#productreviewratingsmetadata) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/products.md b/src/pages/graphql/schema/products/queries/products.md index 21fb3cff2..92d4824a6 100644 --- a/src/pages/graphql/schema/products/queries/products.md +++ b/src/pages/graphql/schema/products/queries/products.md @@ -28,7 +28,7 @@ products( ## Reference -The [`products`](/reference/graphql/latest/index.md#products) reference provides detailed information about the types and fields defined in this query. +The [`products`](/reference/graphql/latest/types-k-p.md#products) reference provides detailed information about the types and fields defined in this query. ## Input attributes diff --git a/src/pages/graphql/schema/store/mutations/contact-us.md b/src/pages/graphql/schema/store/mutations/contact-us.md index 6fe9d5c07..977e8318b 100644 --- a/src/pages/graphql/schema/store/mutations/contact-us.md +++ b/src/pages/graphql/schema/store/mutations/contact-us.md @@ -15,9 +15,9 @@ The `contactUs` mutation submits the contents of the Contact Us form. The `contactUs` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#contactus) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#contactus) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#contactus) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#contactus) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/cms-blocks.md b/src/pages/graphql/schema/store/queries/cms-blocks.md index 57f2cb125..55bad6080 100644 --- a/src/pages/graphql/schema/store/queries/cms-blocks.md +++ b/src/pages/graphql/schema/store/queries/cms-blocks.md @@ -18,7 +18,7 @@ Return the contents of one or more CMS blocks: ## Reference -The [`cmsBlocks`](/reference/graphql/latest/index.md#cmsblocks) reference provides detailed information about the types and fields defined in this query. +The [`cmsBlocks`](/reference/graphql/latest/types-c-e.md#cmsblocks) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/cms-page.md b/src/pages/graphql/schema/store/queries/cms-page.md index 54a2f93c3..2f135a81f 100644 --- a/src/pages/graphql/schema/store/queries/cms-page.md +++ b/src/pages/graphql/schema/store/queries/cms-page.md @@ -18,7 +18,7 @@ Return the contents of a CMS page: ## Reference -The [`cmsPage`](/reference/graphql/latest/index.md#cmspage) reference provides detailed information about the types and fields defined in this query. +The [`cmsPage`](/reference/graphql/latest/types-c-e.md#cmspage) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/country.md b/src/pages/graphql/schema/store/queries/country.md index e1fc86824..bdca6c8c5 100644 --- a/src/pages/graphql/schema/store/queries/country.md +++ b/src/pages/graphql/schema/store/queries/country.md @@ -17,9 +17,9 @@ Use the [countries](countries.md) query to retrieve a list of countries availabl The `country` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#country) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#country) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#country) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#country) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/currency.md b/src/pages/graphql/schema/store/queries/currency.md index c38ccdb4f..189555627 100644 --- a/src/pages/graphql/schema/store/queries/currency.md +++ b/src/pages/graphql/schema/store/queries/currency.md @@ -15,9 +15,9 @@ Use the `currency` query to return information about the store's currency config The `currency` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#currency) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#currency) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#currency) +* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#currency) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/dynamic-blocks.md b/src/pages/graphql/schema/store/queries/dynamic-blocks.md index 214ffd345..5d876d405 100644 --- a/src/pages/graphql/schema/store/queries/dynamic-blocks.md +++ b/src/pages/graphql/schema/store/queries/dynamic-blocks.md @@ -52,7 +52,7 @@ dynamicBlocks( ## Reference -The [`dynamicBlocks`](/reference/graphql/latest/index.md#dynamicblocks) reference provides detailed information about the types and fields defined in this query. +The [`dynamicBlocks`](/reference/graphql/latest/types-c-e.md#dynamicblocks) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/store-config.md b/src/pages/graphql/schema/store/queries/store-config.md index d8ac90123..6435b1480 100644 --- a/src/pages/graphql/schema/store/queries/store-config.md +++ b/src/pages/graphql/schema/store/queries/store-config.md @@ -15,9 +15,9 @@ The `storeConfig` query defines information about a store's configuration. You c The `storeConfig` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#storeconfig) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-q-s.md#storeconfig) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#storeconfig) +* [On-Premises/Cloud](/reference/graphql/latest/types-q-s.md#storeconfig) ## Example usage diff --git a/src/pages/graphql/schema/uploads/mutations/finish-upload.md b/src/pages/graphql/schema/uploads/mutations/finish-upload.md index 8e546fc52..b1cb7b505 100644 --- a/src/pages/graphql/schema/uploads/mutations/finish-upload.md +++ b/src/pages/graphql/schema/uploads/mutations/finish-upload.md @@ -24,7 +24,7 @@ mutation { ## Reference -The [`finishUpload`](/reference/graphql/saas/index.md#finishupload) reference provides detailed information about the types and fields defined in this mutation. +The [`finishUpload`](/reference/graphql/saas/mutations.md#finishupload) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/uploads/mutations/initiate-upload.md b/src/pages/graphql/schema/uploads/mutations/initiate-upload.md index 8b3f3a57f..dc14e4736 100644 --- a/src/pages/graphql/schema/uploads/mutations/initiate-upload.md +++ b/src/pages/graphql/schema/uploads/mutations/initiate-upload.md @@ -36,7 +36,7 @@ mutation { ## Reference -The [`initiateUpload`](/reference/graphql/saas/index.md#initiateupload) reference provides detailed information about the types and fields defined in this mutation. +The [`initiateUpload`](/reference/graphql/saas/mutations.md#initiateupload) reference provides detailed information about the types and fields defined in this mutation. ## Example usage diff --git a/src/pages/graphql/schema/wishlist/interfaces/wishlist.md b/src/pages/graphql/schema/wishlist/interfaces/wishlist.md index c5b2e2cea..94432936f 100644 --- a/src/pages/graphql/schema/wishlist/interfaces/wishlist.md +++ b/src/pages/graphql/schema/wishlist/interfaces/wishlist.md @@ -19,9 +19,9 @@ description: WishlistItemInterface provides details about items in a wish list. The `WishlistItemInterface` reference provides detailed information about the types and fields defined in this interface. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#wishlistiteminterface) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-t-z.md#wishlistiteminterface) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#wishlistiteminterface) +* [On-Premises/Cloud](/reference/graphql/latest/types-t-z.md#wishlistiteminterface) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md b/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md index 5f1c8fffb..887d9e6f1 100644 --- a/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md +++ b/src/pages/graphql/schema/wishlist/mutations/add-items-to-cart.md @@ -26,9 +26,9 @@ mutation { The `addWishlistItemsToCart` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addwishlistitemstocart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addwishlistitemstocart) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addwishlistitemstocart) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addwishlistitemstocart) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/add-products.md b/src/pages/graphql/schema/wishlist/mutations/add-products.md index 7655501db..d19a3319c 100644 --- a/src/pages/graphql/schema/wishlist/mutations/add-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/add-products.md @@ -36,9 +36,9 @@ To determine whether wish lists are enabled, specify the `magento_wishlist_gener The `addProductsToWishlist` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#addproductstowishlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#addproductstowishlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#addproductstowishlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#addproductstowishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/clear.md b/src/pages/graphql/schema/wishlist/mutations/clear.md index 8f233e30f..82e80c493 100644 --- a/src/pages/graphql/schema/wishlist/mutations/clear.md +++ b/src/pages/graphql/schema/wishlist/mutations/clear.md @@ -37,7 +37,7 @@ mutation { [//]: # (## Reference) [//]: # () -[//]: # (The [`clearWishlist`](/reference/graphql/latest/index.md#clearwishlist) reference provides detailed information about the types and fields defined in this mutation.) +[//]: # (The [`clearWishlist`](/reference/graphql/latest/mutations.md#clearwishlist) reference provides detailed information about the types and fields defined in this mutation.) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/copy-products.md b/src/pages/graphql/schema/wishlist/mutations/copy-products.md index 90697a7be..46bb1ae4b 100644 --- a/src/pages/graphql/schema/wishlist/mutations/copy-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/copy-products.md @@ -31,9 +31,9 @@ mutation { The `copyProductsBetweenWishlists` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#copyproductsbetweenwishlists) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#copyproductsbetweenwishlists) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#copyproductsbetweenwishlists) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#copyproductsbetweenwishlists) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/create.md b/src/pages/graphql/schema/wishlist/mutations/create.md index 573375819..d9ff64a9c 100644 --- a/src/pages/graphql/schema/wishlist/mutations/create.md +++ b/src/pages/graphql/schema/wishlist/mutations/create.md @@ -33,9 +33,9 @@ mutation { The `createWishlist` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#createwishlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#createwishlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#createwishlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#createwishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/delete.md b/src/pages/graphql/schema/wishlist/mutations/delete.md index ad3d433c8..48bca7224 100644 --- a/src/pages/graphql/schema/wishlist/mutations/delete.md +++ b/src/pages/graphql/schema/wishlist/mutations/delete.md @@ -23,9 +23,9 @@ mutation { The `deleteWishlist` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#deletewishlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#deletewishlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#deletewishlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#deletewishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/move-products.md b/src/pages/graphql/schema/wishlist/mutations/move-products.md index 2a939bec7..3f4b25f2c 100644 --- a/src/pages/graphql/schema/wishlist/mutations/move-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/move-products.md @@ -32,9 +32,9 @@ mutation { The `moveProductsBetweenWishlists` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#moveproductsbetweenwishlists) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#moveproductsbetweenwishlists) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#moveproductsbetweenwishlists) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#moveproductsbetweenwishlists) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/remove-products.md b/src/pages/graphql/schema/wishlist/mutations/remove-products.md index 8d9626049..785050aeb 100644 --- a/src/pages/graphql/schema/wishlist/mutations/remove-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/remove-products.md @@ -26,9 +26,9 @@ mutation { The `removeProductsFromWishlist` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#removeproductsfromwishlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#removeproductsfromwishlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#removeproductsfromwishlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#removeproductsfromwishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/update-products.md b/src/pages/graphql/schema/wishlist/mutations/update-products.md index 1366c9d6c..02e8fb75d 100644 --- a/src/pages/graphql/schema/wishlist/mutations/update-products.md +++ b/src/pages/graphql/schema/wishlist/mutations/update-products.md @@ -30,9 +30,9 @@ mutation { The `updateProductsInWishlist` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updateproductsinwishlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updateproductsinwishlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updateproductsinwishlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updateproductsinwishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/mutations/update.md b/src/pages/graphql/schema/wishlist/mutations/update.md index 47eb00011..02e661429 100644 --- a/src/pages/graphql/schema/wishlist/mutations/update.md +++ b/src/pages/graphql/schema/wishlist/mutations/update.md @@ -33,9 +33,9 @@ mutation { The `updateWishlist` reference provides detailed information about the types and fields defined in this mutation. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#updatewishlist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/mutations.md#updatewishlist) -* [On-Premises/Cloud](/reference/graphql/latest/index.md#updatewishlist) +* [On-Premises/Cloud](/reference/graphql/latest/mutations.md#updatewishlist) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/queries/wishlist.md b/src/pages/graphql/schema/wishlist/queries/wishlist.md index fbee27b81..6de0f77a3 100644 --- a/src/pages/graphql/schema/wishlist/queries/wishlist.md +++ b/src/pages/graphql/schema/wishlist/queries/wishlist.md @@ -20,7 +20,7 @@ Use the `wishlist` query to retrieve information about a customer's wish list. [ ## Reference -The [`wishlist`](/reference/graphql/latest/index.md#wishlist) reference provides detailed information about the types and fields defined in this query. +The [`wishlist`](/reference/graphql/latest/types-t-z.md#wishlist) reference provides detailed information about the types and fields defined in this query. ## Example usage From 4b1ff93e126ca675c67413b6829bcba4534cda55 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 23 Jun 2026 19:43:05 +0000 Subject: [PATCH 08/10] chore: auto-generate contributors --- src/pages/contributors.json | 1016 +++++++++++++++++++++++------------ 1 file changed, 660 insertions(+), 356 deletions(-) diff --git a/src/pages/contributors.json b/src/pages/contributors.json index 26e64845c..39dd0b927 100644 --- a/src/pages/contributors.json +++ b/src/pages/contributors.json @@ -1,7 +1,7 @@ { - "total": 567, + "total": 613, "offset": 0, - "limit": 567, + "limit": 613, "data": [ { "page": "/", @@ -21,7 +21,7 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/get-started/", @@ -198,7 +198,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/develop/", @@ -401,64 +401,65 @@ { "page": "/graphql/payment-services-extension/mutations/add-products-new-cart", "avatars": [ - "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/mutations/complete-order", "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/mutations/create-payment-order", "avatars": [ - "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/mutations/create-vault-card-payment-token", "avatars": [ - "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/mutations/create-vault-card-setup-token", "avatars": [ - "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/mutations/set-cart-inactive", "avatars": [ - "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/mutations/sync-payment-order", "avatars": [ - "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/38460853?v=4" ], - "lastUpdated": "6/8/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/payment-services-extension/queries/", @@ -574,7 +575,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/release-notes", @@ -613,7 +614,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/", @@ -631,7 +632,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-cart-item", @@ -640,7 +641,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-company", @@ -649,7 +650,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-credit-memo", @@ -658,7 +659,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-credit-memo-item", @@ -667,7 +668,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-invoice", @@ -676,7 +677,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-invoice-item", @@ -685,7 +686,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/mutations/set-custom-negotiable-quote", @@ -694,7 +695,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/queries/", @@ -717,7 +718,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/attributes/queries/attributes-list", @@ -730,7 +731,7 @@ "https://avatars.githubusercontent.com/u/1092519?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/attributes/queries/attributes-metadata", @@ -750,7 +751,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/attributes/queries/custom-attribute-metadata-v2", @@ -764,7 +765,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/16324697?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/company/", @@ -794,7 +795,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/create", @@ -805,7 +806,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/1667889?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/create-role", @@ -815,7 +816,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/create-team", @@ -825,7 +826,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/create-user", @@ -835,7 +836,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/delete-role", @@ -845,7 +846,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/delete-team", @@ -855,7 +856,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/delete-user", @@ -865,7 +866,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/unassign-child-company", @@ -874,7 +875,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/update", @@ -884,7 +885,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/update-role", @@ -894,7 +895,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/update-structure", @@ -904,7 +905,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/update-team", @@ -914,7 +915,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/mutations/update-user", @@ -924,7 +925,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/queries/", @@ -946,7 +947,7 @@ "https://avatars.githubusercontent.com/u/97607802?v=4", "https://avatars.githubusercontent.com/u/11199531?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/company/queries/is-company-admin-email-available", @@ -956,7 +957,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/company/queries/is-company-email-available", @@ -966,7 +967,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/company/queries/is-company-role-name-available", @@ -976,7 +977,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/company/queries/is-company-user-email-available", @@ -986,7 +987,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/company/unions/", @@ -1006,7 +1007,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/", @@ -1026,7 +1027,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/", @@ -1047,7 +1048,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/delete", @@ -1057,7 +1058,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/place-order", @@ -1067,7 +1068,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/place-order-v2", @@ -1076,7 +1077,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/remove-items", @@ -1086,7 +1087,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/request", @@ -1096,7 +1097,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/send-for-review", @@ -1106,7 +1107,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/set-billing-address", @@ -1116,7 +1117,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/set-payment-method", @@ -1126,7 +1127,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/set-quote-template-expiration-date", @@ -1136,7 +1137,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-address", @@ -1146,7 +1147,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/set-shipping-methods", @@ -1156,7 +1157,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/mutations/update-quantities", @@ -1166,7 +1167,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/queries/", @@ -1187,7 +1188,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/queries/quotes", @@ -1197,7 +1198,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/queries/templates", @@ -1206,7 +1207,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/unions/", @@ -1216,7 +1217,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order-rule/", @@ -1227,7 +1228,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order-rule/interfaces/", @@ -1239,7 +1240,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order-rule/mutations/", @@ -1261,7 +1262,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order-rule/mutations/delete", @@ -1272,7 +1273,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order-rule/mutations/update", @@ -1283,7 +1284,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order-rule/mutations/validate", @@ -1294,7 +1295,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/", @@ -1328,7 +1329,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/mutations/add-items-to-cart", @@ -1340,7 +1341,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/mutations/approve", @@ -1351,7 +1352,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/mutations/cancel", @@ -1362,7 +1363,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/mutations/place-order", @@ -1374,7 +1375,7 @@ "https://avatars.githubusercontent.com/u/6391769?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/mutations/place-purchase-order", @@ -1385,7 +1386,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/6391769?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/purchase-order/mutations/reject", @@ -1396,7 +1397,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2028541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/", @@ -1417,7 +1418,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/interfaces/item", @@ -1428,7 +1429,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/", @@ -1450,7 +1451,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/add-products", @@ -1460,7 +1461,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/clear-customer-cart", @@ -1470,7 +1471,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/copy-items", @@ -1480,7 +1481,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/create", @@ -1490,7 +1491,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/delete", @@ -1500,7 +1501,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/delete-items", @@ -1510,7 +1511,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/import-shared-requisition-list", @@ -1520,7 +1521,7 @@ "https://avatars.githubusercontent.com/u/108055538?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/move-items", @@ -1530,7 +1531,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-email", @@ -1539,7 +1540,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/share-requisition-list-by-token", @@ -1548,7 +1549,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/update", @@ -1558,7 +1559,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/mutations/update-items", @@ -1568,7 +1569,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/b2b/requisition-list/queries/", @@ -1609,7 +1610,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/", @@ -1631,7 +1632,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/add-configurable-products", @@ -1642,7 +1643,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/add-downloadable-products", @@ -1653,7 +1654,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/add-products", @@ -1666,7 +1667,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/30629803?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/add-simple-products", @@ -1677,7 +1678,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/add-virtual-products", @@ -1688,7 +1689,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/apply-coupon", @@ -1699,7 +1700,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/apply-coupons", @@ -1710,7 +1711,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/apply-giftcard", @@ -1720,7 +1721,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/apply-reward-points", @@ -1731,7 +1732,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/apply-store-credit", @@ -1741,7 +1742,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/assign-customer-to-guest-cart", @@ -1752,7 +1753,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/clear-cart", @@ -1763,7 +1764,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/create-empty-cart", @@ -1774,7 +1775,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/create-guest-cart", @@ -1786,7 +1787,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/estimate-shipping-methods", @@ -1796,7 +1797,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/3187617?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/estimate-totals", @@ -1806,7 +1807,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/3187617?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/merge", @@ -1817,7 +1818,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/place-order", @@ -1829,7 +1830,7 @@ "https://avatars.githubusercontent.com/u/16324697?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/redeem-giftcard-balance", @@ -1839,7 +1840,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/remove-coupon", @@ -1850,7 +1851,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/remove-coupons", @@ -1861,7 +1862,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/remove-giftcard", @@ -1871,7 +1872,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/remove-item", @@ -1882,7 +1883,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/remove-reward-points", @@ -1892,7 +1893,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/remove-store-credit", @@ -1902,7 +1903,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-billing-address", @@ -1914,7 +1915,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/3187617?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-gift-options", @@ -1925,7 +1926,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-guest-email", @@ -1935,7 +1936,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-payment-method", @@ -1945,7 +1946,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-payment-place-order", @@ -1955,7 +1956,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-shipping-address", @@ -1966,7 +1967,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/3187617?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/set-shipping-method", @@ -1976,7 +1977,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/mutations/update-items", @@ -1987,7 +1988,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/queries/", @@ -1998,7 +1999,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/queries/cart", @@ -2011,7 +2012,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/8588853?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/cart/queries/pickup-locations", @@ -2021,7 +2022,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/catalog-service/", @@ -2112,7 +2113,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/checkout/mutations/create-klarna-payments-session", @@ -2132,7 +2133,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/checkout/mutations/create-paypal-express-token", @@ -2142,7 +2143,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/checkout/mutations/delete-payment-token", @@ -2152,7 +2153,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/checkout/mutations/handle-payflow-pro-response", @@ -2162,7 +2163,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/checkout/queries/", @@ -2183,7 +2184,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/checkout/queries/customer-payment-tokens", @@ -2193,7 +2194,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/checkout/queries/get-hosted-pro-url", @@ -2203,7 +2204,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/checkout/queries/get-payflow-link-token", @@ -2213,7 +2214,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/customer/", @@ -2224,7 +2225,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/", @@ -2245,7 +2246,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/change-password", @@ -2255,7 +2256,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/confirm-email", @@ -2266,7 +2267,7 @@ "https://avatars.githubusercontent.com/u/108055538?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/create", @@ -2276,7 +2277,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/create-address", @@ -2287,7 +2288,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/create-v2", @@ -2298,7 +2299,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/delete-address", @@ -2308,7 +2309,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/delete-address-v2", @@ -2318,7 +2319,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/161452743?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/exchange-external-customer-token", @@ -2337,7 +2338,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/generate-token", @@ -2348,7 +2349,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/generate-token-as-admin", @@ -2358,7 +2359,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/request-password-reset-email", @@ -2368,7 +2369,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/resend-confirmation-email", @@ -2378,7 +2379,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/reset-password", @@ -2388,7 +2389,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/revoke-token", @@ -2398,7 +2399,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/send-email-to-friend", @@ -2408,7 +2409,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/subscribe-email-to-newsletter", @@ -2418,7 +2419,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/update", @@ -2428,7 +2429,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/update-address", @@ -2439,7 +2440,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/update-address-v2", @@ -2449,7 +2450,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/161452743?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/update-email", @@ -2459,7 +2460,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/mutations/update-v2", @@ -2470,7 +2471,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/queries/", @@ -2490,7 +2491,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/customer/queries/customer", @@ -2503,7 +2504,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/6130991?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/queries/customer-group", @@ -2531,7 +2532,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/queries/giftcard-account", @@ -2541,7 +2542,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/customer/queries/is-email-available", @@ -2552,7 +2553,7 @@ "https://avatars.githubusercontent.com/u/11199531?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/customer/queries/orders", @@ -2562,7 +2563,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/", @@ -2591,7 +2592,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/create", @@ -2601,7 +2602,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/move-cart-items", @@ -2611,7 +2612,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/remove", @@ -2621,7 +2622,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/remove-items", @@ -2631,7 +2632,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/remove-registrants", @@ -2641,7 +2642,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/share", @@ -2651,7 +2652,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/update", @@ -2661,7 +2662,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/update-items", @@ -2671,7 +2672,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/mutations/update-registrants", @@ -2681,7 +2682,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/queries/", @@ -2700,7 +2701,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/gift-registry/queries/gift-registry", @@ -2710,7 +2711,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/gift-registry/queries/id-search", @@ -2720,7 +2721,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/gift-registry/queries/type-search", @@ -2730,7 +2731,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/gift-registry/queries/types", @@ -2740,7 +2741,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/live-search/", @@ -2809,7 +2810,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/interfaces/invoice-item", @@ -2819,7 +2820,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/interfaces/order-item", @@ -2829,7 +2830,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/interfaces/shipment-item", @@ -2839,7 +2840,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/", @@ -2858,7 +2859,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/add-return-tracking", @@ -2868,7 +2869,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/cancel-order", @@ -2880,7 +2881,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/confirm-cancel-order", @@ -2890,7 +2891,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/confirm-return", @@ -2901,7 +2902,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/remove-return-tracking", @@ -2911,7 +2912,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/reorder-items", @@ -2922,7 +2923,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/request-guest-order-cancel", @@ -2932,7 +2933,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/request-guest-return", @@ -2943,7 +2944,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/2188119?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/mutations/request-return", @@ -2954,7 +2955,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/39598117?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/orders/queries/", @@ -2973,7 +2974,7 @@ "https://avatars.githubusercontent.com/u/161452743?v=4", "https://avatars.githubusercontent.com/u/16324697?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/orders/queries/guest-order-by-token", @@ -2983,7 +2984,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/16324697?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/product-recommendations/", @@ -3033,7 +3034,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/attribute-metadata", @@ -3055,7 +3056,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/category", @@ -3066,7 +3067,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/customizable-option", @@ -3077,7 +3078,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/pwa-implementations", @@ -3099,7 +3100,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/8973208?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/", @@ -3110,7 +3111,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/bundle", @@ -3121,7 +3122,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/configurable", @@ -3132,7 +3133,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/downloadable", @@ -3143,7 +3144,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/gift-card", @@ -3154,7 +3155,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/grouped", @@ -3165,7 +3166,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/simple", @@ -3176,7 +3177,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/interfaces/types/virtual", @@ -3187,7 +3188,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/", @@ -3206,7 +3207,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/assign-compare-list", @@ -3216,7 +3217,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/create-compare-list", @@ -3226,7 +3227,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/create-review", @@ -3236,7 +3237,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/delete-compare-list", @@ -3246,7 +3247,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/remove-from-compare-list", @@ -3256,7 +3257,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/subscribe-product-alert-price", @@ -3265,7 +3266,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/subscribe-product-alert-stock", @@ -3274,7 +3275,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/unsubscribe-product-alert-price", @@ -3283,7 +3284,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/unsubscribe-product-alert-price-all", @@ -3292,7 +3293,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/mutations/unsubscribe-product-alert-stock", @@ -3310,7 +3311,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/queries/", @@ -3330,7 +3331,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/products/queries/category", @@ -3340,7 +3341,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/products/queries/category-list", @@ -3350,7 +3351,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/products/queries/compare-list", @@ -3360,7 +3361,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/queries/is-subscribed-product-alert-price", @@ -3388,7 +3389,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/queries/products", @@ -3401,7 +3402,7 @@ "https://avatars.githubusercontent.com/u/1092519?v=4", "https://avatars.githubusercontent.com/u/7840447?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/products/queries/route", @@ -3412,7 +3413,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/111579196?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/products/queries/url-resolver", @@ -3422,7 +3423,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/store/", @@ -3451,7 +3452,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/store/queries/", @@ -3471,7 +3472,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/store/queries/cms-blocks", @@ -3482,7 +3483,7 @@ "https://avatars.githubusercontent.com/u/11199531?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/store/queries/cms-page", @@ -3493,7 +3494,7 @@ "https://avatars.githubusercontent.com/u/11199531?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/store/queries/countries", @@ -3503,7 +3504,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/store/queries/country", @@ -3513,7 +3514,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/store/queries/currency", @@ -3523,7 +3524,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/store/queries/dynamic-blocks", @@ -3535,7 +3536,7 @@ "https://avatars.githubusercontent.com/u/3396658?v=4", "https://avatars.githubusercontent.com/u/45772211?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/store/queries/recaptcha-form-config", @@ -3546,7 +3547,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/3187617?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/store/queries/recaptcha-form-configs", @@ -3566,7 +3567,7 @@ "https://avatars.githubusercontent.com/u/98363870?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/graphql/schema/store/queries/store-config", @@ -3578,7 +3579,7 @@ "https://avatars.githubusercontent.com/u/16324697?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/storefront-services/", @@ -3606,7 +3607,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/uploads/mutations/initiate-upload", @@ -3615,7 +3616,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/11652541?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/", @@ -3643,7 +3644,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/", @@ -3662,7 +3663,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/add-products", @@ -3672,7 +3673,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/clear", @@ -3681,7 +3682,7 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/108055538?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/copy-products", @@ -3691,7 +3692,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/create", @@ -3701,7 +3702,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/delete", @@ -3711,7 +3712,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/move-products", @@ -3721,7 +3722,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/remove-products", @@ -3731,7 +3732,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/update", @@ -3741,7 +3742,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/mutations/update-products", @@ -3751,7 +3752,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/schema/wishlist/queries/", @@ -3770,7 +3771,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { "page": "/graphql/tutorials/", @@ -4017,7 +4018,7 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-6-queries", @@ -4025,31 +4026,49 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-6-types-1", + "page": "/includes/autogenerated/graphql-api-2-4-6-types-a-b", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-6-types-2", + "page": "/includes/autogenerated/graphql-api-2-4-6-types-c-e", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-6-types-3", + "page": "/includes/autogenerated/graphql-api-2-4-6-types-f-i", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/23/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-6-types-k-p", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-6-types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-6-types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-7-mutations", @@ -4057,7 +4076,7 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-7-queries", @@ -4065,39 +4084,49 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-7-types-1", + "page": "/includes/autogenerated/graphql-api-2-4-7-types-a-b", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-7-types-2", + "page": "/includes/autogenerated/graphql-api-2-4-7-types-c-e", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-7-types-3", + "page": "/includes/autogenerated/graphql-api-2-4-7-types-f-i", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/23/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-7-types-4", + "page": "/includes/autogenerated/graphql-api-2-4-7-types-k-p", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-7-types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-7-types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-8-mutations", @@ -4105,7 +4134,7 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-8-queries", @@ -4113,39 +4142,49 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-8-types-1", + "page": "/includes/autogenerated/graphql-api-2-4-8-types-a-b", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-8-types-2", + "page": "/includes/autogenerated/graphql-api-2-4-8-types-c-e", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-8-types-3", + "page": "/includes/autogenerated/graphql-api-2-4-8-types-f-i", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/23/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-8-types-4", + "page": "/includes/autogenerated/graphql-api-2-4-8-types-k-p", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-8-types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-8-types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-9-mutations", @@ -4153,7 +4192,7 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-2-4-9-queries", @@ -4161,39 +4200,49 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-9-types-1", + "page": "/includes/autogenerated/graphql-api-2-4-9-types-a-b", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-9-types-2", + "page": "/includes/autogenerated/graphql-api-2-4-9-types-c-e", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-9-types-3", + "page": "/includes/autogenerated/graphql-api-2-4-9-types-f-i", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/23/2026" }, { - "page": "/includes/autogenerated/graphql-api-2-4-9-types-4", + "page": "/includes/autogenerated/graphql-api-2-4-9-types-k-p", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-9-types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-2-4-9-types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-saas-mutations", @@ -4201,7 +4250,7 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { "page": "/includes/autogenerated/graphql-api-saas-queries", @@ -4209,39 +4258,49 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-saas-types-1", + "page": "/includes/autogenerated/graphql-api-saas-types-a-b", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-saas-types-2", + "page": "/includes/autogenerated/graphql-api-saas-types-c-e", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-saas-types-3", + "page": "/includes/autogenerated/graphql-api-saas-types-f-i", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/includes/autogenerated/graphql-api-saas-types-4", + "page": "/includes/autogenerated/graphql-api-saas-types-k-p", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/4/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-saas-types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/includes/autogenerated/graphql-api-saas-types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/includes/commerce-only", @@ -4443,19 +4502,61 @@ "lastUpdated": "6/2/2026" }, { - "page": "/reference/graphql/", + "page": "/reference/graphql/2-4-6/", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4", + "https://avatars.githubusercontent.com/u/14320591?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-6/mutations", "avatars": [ "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/3/2026" + "lastUpdated": "6/22/2026" }, { - "page": "/reference/graphql/2-4-6/", + "page": "/reference/graphql/2-4-6/types-a-b", "avatars": [ - "https://avatars.githubusercontent.com/u/12731225?v=4", - "https://avatars.githubusercontent.com/u/14320591?v=4" + "https://avatars.githubusercontent.com/u/12731225?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-6/types-c-e", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-6/types-f-i", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-6/types-k-p", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-6/types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-6/types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/reference/graphql/2-4-7/", @@ -4463,7 +4564,56 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/mutations", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/types-a-b", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/types-c-e", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/types-f-i", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/types-k-p", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-7/types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/reference/graphql/2-4-8/", @@ -4471,7 +4621,112 @@ "https://avatars.githubusercontent.com/u/12731225?v=4", "https://avatars.githubusercontent.com/u/14320591?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/mutations", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/types-a-b", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/types-c-e", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/types-f-i", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/types-k-p", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/2-4-8/types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/mutations", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/types-a-b", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/types-c-e", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/types-f-i", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/types-k-p", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/latest/types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/reference/graphql/saas/", @@ -4480,7 +4735,56 @@ "https://avatars.githubusercontent.com/u/14320591?v=4", "https://avatars.githubusercontent.com/u/98363870?v=4" ], - "lastUpdated": "6/2/2026" + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/mutations", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/types-a-b", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/types-c-e", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/types-f-i", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/types-k-p", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/types-q-s", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" + }, + { + "page": "/reference/graphql/saas/types-t-z", + "avatars": [ + "https://avatars.githubusercontent.com/u/12731225?v=4" + ], + "lastUpdated": "6/22/2026" }, { "page": "/reference/rest/paas", From d5425a3d1baa9e169274fa6e9cb7d240f6137295 Mon Sep 17 00:00:00 2001 From: Dima Shevtsov Date: Wed, 24 Jun 2026 15:46:20 -0500 Subject: [PATCH 09/10] Revert "fix: update GraphQL references to point to the correct paths after GraphQL docs restructuring" and fix the GraphQL references This reverts commit 04a7d0527cb35e8ab090bac2b022fc8a7cf12e99. --- .../schema/attributes/queries/custom-attribute-metadata.md | 2 +- src/pages/graphql/schema/b2b/company/queries/company.md | 4 ++-- .../graphql/schema/b2b/negotiable-quote/queries/quote.md | 4 ++-- src/pages/graphql/schema/cart/queries/cart.md | 4 ++-- src/pages/graphql/schema/cart/queries/pickup-locations.md | 4 ++-- .../schema/checkout/queries/customer-payment-tokens.md | 4 ++-- src/pages/graphql/schema/customer/queries/customer.md | 4 ++-- .../graphql/schema/customer/queries/downloadable-products.md | 2 +- src/pages/graphql/schema/customer/queries/giftcard-account.md | 4 ++-- src/pages/graphql/schema/customer/queries/orders.md | 2 +- .../graphql/schema/gift-registry/queries/gift-registry.md | 4 ++-- src/pages/graphql/schema/products/queries/compare-list.md | 4 ++-- .../products/queries/product-review-ratings-metadata.md | 2 +- src/pages/graphql/schema/products/queries/products.md | 2 +- src/pages/graphql/schema/store/queries/cms-blocks.md | 2 +- src/pages/graphql/schema/store/queries/cms-page.md | 2 +- src/pages/graphql/schema/store/queries/country.md | 4 ++-- src/pages/graphql/schema/store/queries/currency.md | 4 ++-- src/pages/graphql/schema/store/queries/dynamic-blocks.md | 2 +- src/pages/graphql/schema/store/queries/store-config.md | 4 ++-- src/pages/graphql/schema/wishlist/queries/wishlist.md | 2 +- 21 files changed, 33 insertions(+), 33 deletions(-) diff --git a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md index 35ceb0bfd..3b0e2e1e6 100644 --- a/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md +++ b/src/pages/graphql/schema/attributes/queries/custom-attribute-metadata.md @@ -21,7 +21,7 @@ The `StorefrontProperties` output object returns information about a product att The `customAttributeMetadata` reference provides detailed information about the types and fields defined in this query. -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#customattributemetadata) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#customattributemetadata) ## Example usage diff --git a/src/pages/graphql/schema/b2b/company/queries/company.md b/src/pages/graphql/schema/b2b/company/queries/company.md index dcd88e927..9b6869b1a 100644 --- a/src/pages/graphql/schema/b2b/company/queries/company.md +++ b/src/pages/graphql/schema/b2b/company/queries/company.md @@ -25,9 +25,9 @@ This query requires a valid [customer authentication token](../../../customer/mu The `company` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#company) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#company) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#company) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#company) ## Example usage 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 021efcb46..6f5b8a057 100644 --- a/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md +++ b/src/pages/graphql/schema/b2b/negotiable-quote/queries/quote.md @@ -23,9 +23,9 @@ negotiableQuote (uid ID!): NegotiableQuote The `negotiableQuote` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#negotiablequote) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#negotiablequote) -* [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#negotiablequote) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#negotiablequote) ## Example usage diff --git a/src/pages/graphql/schema/cart/queries/cart.md b/src/pages/graphql/schema/cart/queries/cart.md index b00e5dcb4..2b086272e 100644 --- a/src/pages/graphql/schema/cart/queries/cart.md +++ b/src/pages/graphql/schema/cart/queries/cart.md @@ -21,9 +21,9 @@ Cart functionality is defined in the `Quote` module. A Quote represents the cont The `cart` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#cart) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#cart) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#cart) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#cart) ## Sample queries diff --git a/src/pages/graphql/schema/cart/queries/pickup-locations.md b/src/pages/graphql/schema/cart/queries/pickup-locations.md index a695d8738..fd4acb07f 100644 --- a/src/pages/graphql/schema/cart/queries/pickup-locations.md +++ b/src/pages/graphql/schema/cart/queries/pickup-locations.md @@ -37,9 +37,9 @@ pickupLocations (area: AreaInput filters: PickupLocationFilterInput sort: Pickup The `pickupLocations` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-k-p.md#pickuplocations) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#pickuplocations) -* [On-Premises/Cloud](/reference/graphql/latest/types-k-p.md#pickuplocations) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#pickuplocations) ## Example usage diff --git a/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md b/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md index 6ec7bf494..add900677 100644 --- a/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md +++ b/src/pages/graphql/schema/checkout/queries/customer-payment-tokens.md @@ -21,9 +21,9 @@ You must specify the customer's authorization token in the header of the call. The `customerPaymentTokens` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#customerpaymenttokens) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customerpaymenttokens) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#customerpaymenttokens) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#customerpaymenttokens) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/customer.md b/src/pages/graphql/schema/customer/queries/customer.md index 32678670a..3289acbd8 100644 --- a/src/pages/graphql/schema/customer/queries/customer.md +++ b/src/pages/graphql/schema/customer/queries/customer.md @@ -17,9 +17,9 @@ To retrieve information about a customer, we recommend you use customer tokens i The `customer` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#customer) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#customer) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#customer) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#customer) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/downloadable-products.md b/src/pages/graphql/schema/customer/queries/downloadable-products.md index ada93b16f..c3f8fec91 100644 --- a/src/pages/graphql/schema/customer/queries/downloadable-products.md +++ b/src/pages/graphql/schema/customer/queries/downloadable-products.md @@ -16,7 +16,7 @@ Use the `customerDownloadableProducts` query to retrieve the list of purchased d ## Reference -The [`customerDownloadableProducts`](/reference/graphql/latest/types-c-e.md#customerdownloadableproducts) reference provides detailed information about the types and fields defined in this query. +The [`customerDownloadableProducts`](/reference/graphql/latest/index.md#customerdownloadableproducts) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/giftcard-account.md b/src/pages/graphql/schema/customer/queries/giftcard-account.md index 26278e469..f2c7c1111 100644 --- a/src/pages/graphql/schema/customer/queries/giftcard-account.md +++ b/src/pages/graphql/schema/customer/queries/giftcard-account.md @@ -17,9 +17,9 @@ The `giftCardAccount` query returns information for a specific gift card. The `giftCardAccount` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-f-i.md#giftcardaccount) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftcardaccount) -* [On-Premises/Cloud](/reference/graphql/latest/types-f-i.md#giftcardaccount) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftcardaccount) ## Example usage diff --git a/src/pages/graphql/schema/customer/queries/orders.md b/src/pages/graphql/schema/customer/queries/orders.md index 97a41756c..d7fae077e 100644 --- a/src/pages/graphql/schema/customer/queries/orders.md +++ b/src/pages/graphql/schema/customer/queries/orders.md @@ -22,7 +22,7 @@ We recommend you use customer tokens in the header of your GraphQL calls. Howeve ## Reference -The [`customerOrders`](/reference/graphql/latest/types-c-e.md#customerorders) reference provides detailed information about the types and fields defined in this query. +The [`customerOrders`](/reference/graphql/latest/index.md#customerorders) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/gift-registry/queries/gift-registry.md b/src/pages/graphql/schema/gift-registry/queries/gift-registry.md index eaca99187..a69759d96 100644 --- a/src/pages/graphql/schema/gift-registry/queries/gift-registry.md +++ b/src/pages/graphql/schema/gift-registry/queries/gift-registry.md @@ -21,9 +21,9 @@ giftRegistry(uid: ID!): GiftRegistry The `giftRegistry` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-f-i.md#giftregistry) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#giftregistry) -* [On-Premises/Cloud](/reference/graphql/latest/types-f-i.md#giftregistry) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#giftregistry) ## Example usage diff --git a/src/pages/graphql/schema/products/queries/compare-list.md b/src/pages/graphql/schema/products/queries/compare-list.md index a6c209453..a374aae85 100644 --- a/src/pages/graphql/schema/products/queries/compare-list.md +++ b/src/pages/graphql/schema/products/queries/compare-list.md @@ -19,9 +19,9 @@ compareList( The `compareList` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#comparelist) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#comparelist) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#comparelist) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#comparelist) ## Example usage diff --git a/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md b/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md index 07944d06a..dd359b29b 100644 --- a/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md +++ b/src/pages/graphql/schema/products/queries/product-review-ratings-metadata.md @@ -18,7 +18,7 @@ Use the [`createProductReview` mutation](../mutations/create-review.md) to add a ## Reference -The [`productReviewRatingsMetadata`](/reference/graphql/latest/types-k-p.md#productreviewratingsmetadata) reference provides detailed information about the types and fields defined in this query. +The [`productReviewRatingsMetadata`](/reference/graphql/latest/index.md#productreviewratingsmetadata) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/products/queries/products.md b/src/pages/graphql/schema/products/queries/products.md index 92d4824a6..21fb3cff2 100644 --- a/src/pages/graphql/schema/products/queries/products.md +++ b/src/pages/graphql/schema/products/queries/products.md @@ -28,7 +28,7 @@ products( ## Reference -The [`products`](/reference/graphql/latest/types-k-p.md#products) reference provides detailed information about the types and fields defined in this query. +The [`products`](/reference/graphql/latest/index.md#products) reference provides detailed information about the types and fields defined in this query. ## Input attributes diff --git a/src/pages/graphql/schema/store/queries/cms-blocks.md b/src/pages/graphql/schema/store/queries/cms-blocks.md index 55bad6080..57f2cb125 100644 --- a/src/pages/graphql/schema/store/queries/cms-blocks.md +++ b/src/pages/graphql/schema/store/queries/cms-blocks.md @@ -18,7 +18,7 @@ Return the contents of one or more CMS blocks: ## Reference -The [`cmsBlocks`](/reference/graphql/latest/types-c-e.md#cmsblocks) reference provides detailed information about the types and fields defined in this query. +The [`cmsBlocks`](/reference/graphql/latest/index.md#cmsblocks) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/cms-page.md b/src/pages/graphql/schema/store/queries/cms-page.md index 2f135a81f..54a2f93c3 100644 --- a/src/pages/graphql/schema/store/queries/cms-page.md +++ b/src/pages/graphql/schema/store/queries/cms-page.md @@ -18,7 +18,7 @@ Return the contents of a CMS page: ## Reference -The [`cmsPage`](/reference/graphql/latest/types-c-e.md#cmspage) reference provides detailed information about the types and fields defined in this query. +The [`cmsPage`](/reference/graphql/latest/index.md#cmspage) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/country.md b/src/pages/graphql/schema/store/queries/country.md index bdca6c8c5..e1fc86824 100644 --- a/src/pages/graphql/schema/store/queries/country.md +++ b/src/pages/graphql/schema/store/queries/country.md @@ -17,9 +17,9 @@ Use the [countries](countries.md) query to retrieve a list of countries availabl The `country` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#country) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#country) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#country) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#country) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/currency.md b/src/pages/graphql/schema/store/queries/currency.md index 189555627..c38ccdb4f 100644 --- a/src/pages/graphql/schema/store/queries/currency.md +++ b/src/pages/graphql/schema/store/queries/currency.md @@ -15,9 +15,9 @@ Use the `currency` query to return information about the store's currency config The `currency` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-c-e.md#currency) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#currency) -* [On-Premises/Cloud](/reference/graphql/latest/types-c-e.md#currency) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#currency) ## Example usage diff --git a/src/pages/graphql/schema/store/queries/dynamic-blocks.md b/src/pages/graphql/schema/store/queries/dynamic-blocks.md index 5d876d405..214ffd345 100644 --- a/src/pages/graphql/schema/store/queries/dynamic-blocks.md +++ b/src/pages/graphql/schema/store/queries/dynamic-blocks.md @@ -52,7 +52,7 @@ dynamicBlocks( ## Reference -The [`dynamicBlocks`](/reference/graphql/latest/types-c-e.md#dynamicblocks) reference provides detailed information about the types and fields defined in this query. +The [`dynamicBlocks`](/reference/graphql/latest/index.md#dynamicblocks) reference provides detailed information about the types and fields defined in this query. ## Example usage diff --git a/src/pages/graphql/schema/store/queries/store-config.md b/src/pages/graphql/schema/store/queries/store-config.md index 6435b1480..d8ac90123 100644 --- a/src/pages/graphql/schema/store/queries/store-config.md +++ b/src/pages/graphql/schema/store/queries/store-config.md @@ -15,9 +15,9 @@ The `storeConfig` query defines information about a store's configuration. You c The `storeConfig` reference provides detailed information about the types and fields defined in this query. -* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/types-q-s.md#storeconfig) +* [Adobe Commerce as a Cloud Service](/reference/graphql/saas/index.md#storeconfig) -* [On-Premises/Cloud](/reference/graphql/latest/types-q-s.md#storeconfig) +* [On-Premises/Cloud](/reference/graphql/latest/index.md#storeconfig) ## Example usage diff --git a/src/pages/graphql/schema/wishlist/queries/wishlist.md b/src/pages/graphql/schema/wishlist/queries/wishlist.md index 6de0f77a3..fbee27b81 100644 --- a/src/pages/graphql/schema/wishlist/queries/wishlist.md +++ b/src/pages/graphql/schema/wishlist/queries/wishlist.md @@ -20,7 +20,7 @@ Use the `wishlist` query to retrieve information about a customer's wish list. [ ## Reference -The [`wishlist`](/reference/graphql/latest/types-t-z.md#wishlist) reference provides detailed information about the types and fields defined in this query. +The [`wishlist`](/reference/graphql/latest/index.md#wishlist) reference provides detailed information about the types and fields defined in this query. ## Example usage From 58c90981b4b4048769e5e41f62a9aa04dd5ac89f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Wed, 24 Jun 2026 21:11:52 +0000 Subject: [PATCH 10/10] chore: auto-generate contributors --- src/pages/contributors.json | 42 ++++++++++++++++++------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/src/pages/contributors.json b/src/pages/contributors.json index 0c2409ab3..a4cbe2cd8 100644 --- a/src/pages/contributors.json +++ b/src/pages/contributors.json @@ -752,7 +752,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/attributes/queries/custom-attribute-metadata-v2", @@ -948,7 +948,7 @@ "https://avatars.githubusercontent.com/u/97607802?v=4", "https://avatars.githubusercontent.com/u/11199531?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/b2b/company/queries/is-company-admin-email-available", @@ -1189,7 +1189,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/b2b/negotiable-quote/queries/quotes", @@ -2013,7 +2013,7 @@ "https://avatars.githubusercontent.com/u/13662379?v=4", "https://avatars.githubusercontent.com/u/8588853?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/cart/queries/pickup-locations", @@ -2023,7 +2023,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/catalog-service/", @@ -2195,7 +2195,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/checkout/queries/get-hosted-pro-url", @@ -2505,7 +2505,7 @@ "https://avatars.githubusercontent.com/u/2188119?v=4", "https://avatars.githubusercontent.com/u/6130991?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/customer/queries/customer-group", @@ -2533,7 +2533,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/customer/queries/giftcard-account", @@ -2543,7 +2543,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/customer/queries/is-email-available", @@ -2564,7 +2564,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/gift-registry/", @@ -2712,7 +2712,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/gift-registry/queries/id-search", @@ -3362,7 +3362,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/products/queries/is-subscribed-product-alert-price", @@ -3390,7 +3390,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/products/queries/products", @@ -3403,7 +3403,7 @@ "https://avatars.githubusercontent.com/u/1092519?v=4", "https://avatars.githubusercontent.com/u/7840447?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/products/queries/route", @@ -3484,7 +3484,7 @@ "https://avatars.githubusercontent.com/u/11199531?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/store/queries/cms-page", @@ -3495,7 +3495,7 @@ "https://avatars.githubusercontent.com/u/11199531?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/store/queries/countries", @@ -3515,7 +3515,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/store/queries/currency", @@ -3525,7 +3525,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/store/queries/dynamic-blocks", @@ -3537,7 +3537,7 @@ "https://avatars.githubusercontent.com/u/3396658?v=4", "https://avatars.githubusercontent.com/u/45772211?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/store/queries/recaptcha-form-config", @@ -3580,7 +3580,7 @@ "https://avatars.githubusercontent.com/u/16324697?v=4", "https://avatars.githubusercontent.com/u/1092519?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/schema/storefront-services/", @@ -3772,7 +3772,7 @@ "https://avatars.githubusercontent.com/u/11652541?v=4", "https://avatars.githubusercontent.com/u/13662379?v=4" ], - "lastUpdated": "6/23/2026" + "lastUpdated": "6/24/2026" }, { "page": "/graphql/tutorials/",